HKIH GraphQL API Reference
Helsinki Headless. All subsites can be queried using https://{site}.content.api.hel.fi/graphql endpoint. Documentation generated from kultus.content.api.hel.fi, other sites may differ.
API Endpoints
https://kultus.content.api.hel.fi/graphql
Queries
allSettings
Description
Entry point to get all settings for the site
Response
Returns a Settings
Example
Query
query allSettings {
allSettings {
discussionSettingsDefaultCommentStatus
discussionSettingsDefaultPingStatus
generalSettingsDateFormat
generalSettingsDescription
generalSettingsLanguage
generalSettingsStartOfWeek
generalSettingsTimeFormat
generalSettingsTimezone
generalSettingsTitle
readingSettingsPageForPosts
readingSettingsPageOnFront
readingSettingsPostsPerPage
readingSettingsShowOnFront
writingSettingsDefaultCategory
writingSettingsDefaultPostFormat
writingSettingsUseSmilies
}
}
Response
{
"data": {
"allSettings": {
"discussionSettingsDefaultCommentStatus": "xyz789",
"discussionSettingsDefaultPingStatus": "abc123",
"generalSettingsDateFormat": "abc123",
"generalSettingsDescription": "abc123",
"generalSettingsLanguage": "abc123",
"generalSettingsStartOfWeek": 987,
"generalSettingsTimeFormat": "xyz789",
"generalSettingsTimezone": "abc123",
"generalSettingsTitle": "xyz789",
"readingSettingsPageForPosts": 123,
"readingSettingsPageOnFront": 987,
"readingSettingsPostsPerPage": 123,
"readingSettingsShowOnFront": "xyz789",
"writingSettingsDefaultCategory": 123,
"writingSettingsDefaultPostFormat": "xyz789",
"writingSettingsUseSmilies": false
}
}
}
categories
Description
Connection between the RootQuery type and the category type
Response
Returns a RootQueryToCategoryConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
The number of items to return after the referenced "after" cursor |
last - Int
|
The number of items to return before the referenced "before" cursor |
after - String
|
Cursor used along with the "first" argument to reference where in the dataset to get data |
before - String
|
Cursor used along with the "last" argument to reference where in the dataset to get data |
where - RootQueryToCategoryConnectionWhereArgs
|
Arguments for filtering the connection |
Example
Query
query categories(
$first: Int,
$last: Int,
$after: String,
$before: String,
$where: RootQueryToCategoryConnectionWhereArgs
) {
categories(
first: $first,
last: $last,
after: $after,
before: $before,
where: $where
) {
edges {
...RootQueryToCategoryConnectionEdgeFragment
}
nodes {
...CategoryFragment
}
pageInfo {
...RootQueryToCategoryConnectionPageInfoFragment
}
}
}
Variables
{
"first": 987,
"last": 987,
"after": "abc123",
"before": "xyz789",
"where": RootQueryToCategoryConnectionWhereArgs
}
Response
{
"data": {
"categories": {
"edges": [RootQueryToCategoryConnectionEdge],
"nodes": [Category],
"pageInfo": RootQueryToCategoryConnectionPageInfo
}
}
}
category
Description
A 0bject
Response
Returns a Category
Arguments
| Name | Description |
|---|---|
id - ID!
|
The globally unique identifier of the object. |
idType - CategoryIdType
|
Type of unique identifier to fetch by. Default is Global ID |
Example
Query
query category(
$id: ID!,
$idType: CategoryIdType
) {
category(
id: $id,
idType: $idType
) {
ancestors {
...CategoryToAncestorsCategoryConnectionFragment
}
categoryId
children {
...CategoryToCategoryConnectionFragment
}
contentNodes {
...CategoryToContentNodeConnectionFragment
}
count
databaseId
description
enqueuedScripts {
...TermNodeToEnqueuedScriptConnectionFragment
}
enqueuedStylesheets {
...TermNodeToEnqueuedStylesheetConnectionFragment
}
id
isComment
isContentNode
isFrontPage
isPostsPage
isRestricted
isTermNode
language {
...LanguageFragment
}
link
name
parent {
...CategoryToParentCategoryConnectionEdgeFragment
}
parentDatabaseId
parentId
posts {
...CategoryToPostConnectionFragment
}
slug
taxonomy {
...CategoryToTaxonomyConnectionEdgeFragment
}
taxonomyName
termGroupId
termTaxonomyId
translation {
...CategoryFragment
}
translations {
...CategoryFragment
}
uri
}
}
Variables
{"id": 4, "idType": "DATABASE_ID"}
Response
{
"data": {
"category": {
"ancestors": CategoryToAncestorsCategoryConnection,
"categoryId": 123,
"children": CategoryToCategoryConnection,
"contentNodes": CategoryToContentNodeConnection,
"count": 987,
"databaseId": 987,
"description": "xyz789",
"enqueuedScripts": TermNodeToEnqueuedScriptConnection,
"enqueuedStylesheets": TermNodeToEnqueuedStylesheetConnection,
"id": "4",
"isComment": true,
"isContentNode": false,
"isFrontPage": true,
"isPostsPage": true,
"isRestricted": true,
"isTermNode": true,
"language": Language,
"link": "abc123",
"name": "abc123",
"parent": CategoryToParentCategoryConnectionEdge,
"parentDatabaseId": 987,
"parentId": "4",
"posts": CategoryToPostConnection,
"slug": "abc123",
"taxonomy": CategoryToTaxonomyConnectionEdge,
"taxonomyName": "abc123",
"termGroupId": 987,
"termTaxonomyId": 123,
"translation": Category,
"translations": [Category],
"uri": "xyz789"
}
}
}
collection
Description
An object of the collection Type. Collections
Response
Returns a Collection
Arguments
| Name | Description |
|---|---|
id - ID!
|
The globally unique identifier of the object. |
idType - CollectionIdType
|
Type of unique identifier to fetch by. Default is Global ID |
asPreview - Boolean
|
Whether to return the Preview Node instead of the Published Node. When the ID of a Node is provided along with asPreview being set to true, the preview node with un-published changes will be returned instead of the published node. If no preview node exists or the requester doesn't have proper capabilities to preview, no node will be returned. If the ID provided is a URI and has a preview query arg, it will be used as a fallback if the "asPreview" argument is not explicitly provided as an argument. |
Example
Query
query collection(
$id: ID!,
$idType: CollectionIdType,
$asPreview: Boolean
) {
collection(
id: $id,
idType: $idType,
asPreview: $asPreview
) {
backgroundColor
collectionId
contentType {
...ContentNodeToContentTypeConnectionEdgeFragment
}
contentTypeName
databaseId
date
dateGmt
description
desiredSlug
editingLockedBy {
...ContentNodeToEditLockConnectionEdgeFragment
}
enclosure
enqueuedScripts {
...ContentNodeToEnqueuedScriptConnectionFragment
}
enqueuedStylesheets {
...ContentNodeToEnqueuedStylesheetConnectionFragment
}
expirationTime
guid
id
image
isComment
isContentNode
isFrontPage
isPostsPage
isPreview
isRestricted
isRevision
isTermNode
language {
...LanguageFragment
}
lastEditedBy {
...ContentNodeToEditLastConnectionEdgeFragment
}
link
modified
modifiedGmt
modules {
... on EventSearch {
...EventSearchFragment
}
... on EventSelected {
...EventSelectedFragment
}
... on EventSearchCarousel {
...EventSearchCarouselFragment
}
... on EventSelectedCarousel {
...EventSelectedCarouselFragment
}
... on LocationsSelected {
...LocationsSelectedFragment
}
... on LocationsSelectedCarousel {
...LocationsSelectedCarouselFragment
}
}
preview {
...CollectionToPreviewConnectionEdgeFragment
}
previewRevisionDatabaseId
previewRevisionId
revisionOf {
...NodeWithRevisionsToContentNodeConnectionEdgeFragment
}
revisions {
...CollectionToRevisionConnectionFragment
}
seo {
...SEOFragment
}
showOnFrontPage
slug
status
template {
...ContentTemplateFragment
}
title
translation {
...CollectionFragment
}
translations {
...CollectionFragment
}
uri
}
}
Variables
{
"id": "4",
"idType": "DATABASE_ID",
"asPreview": true
}
Response
{
"data": {
"collection": {
"backgroundColor": "abc123",
"collectionId": 987,
"contentType": ContentNodeToContentTypeConnectionEdge,
"contentTypeName": "xyz789",
"databaseId": 123,
"date": "xyz789",
"dateGmt": "xyz789",
"description": "abc123",
"desiredSlug": "xyz789",
"editingLockedBy": ContentNodeToEditLockConnectionEdge,
"enclosure": "abc123",
"enqueuedScripts": ContentNodeToEnqueuedScriptConnection,
"enqueuedStylesheets": ContentNodeToEnqueuedStylesheetConnection,
"expirationTime": "xyz789",
"guid": "xyz789",
"id": "4",
"image": "xyz789",
"isComment": false,
"isContentNode": true,
"isFrontPage": true,
"isPostsPage": true,
"isPreview": true,
"isRestricted": false,
"isRevision": true,
"isTermNode": false,
"language": Language,
"lastEditedBy": ContentNodeToEditLastConnectionEdge,
"link": "abc123",
"modified": "xyz789",
"modifiedGmt": "xyz789",
"modules": [EventSearch],
"preview": CollectionToPreviewConnectionEdge,
"previewRevisionDatabaseId": 123,
"previewRevisionId": "4",
"revisionOf": NodeWithRevisionsToContentNodeConnectionEdge,
"revisions": CollectionToRevisionConnection,
"seo": SEO,
"showOnFrontPage": true,
"slug": "abc123",
"status": "abc123",
"template": ContentTemplate,
"title": "abc123",
"translation": Collection,
"translations": [Collection],
"uri": "abc123"
}
}
}
collectionBy
Description
A collection object
Response
Returns a Collection
Example
Query
query collectionBy(
$id: ID,
$collectionId: Int,
$uri: String,
$slug: String
) {
collectionBy(
id: $id,
collectionId: $collectionId,
uri: $uri,
slug: $slug
) {
backgroundColor
collectionId
contentType {
...ContentNodeToContentTypeConnectionEdgeFragment
}
contentTypeName
databaseId
date
dateGmt
description
desiredSlug
editingLockedBy {
...ContentNodeToEditLockConnectionEdgeFragment
}
enclosure
enqueuedScripts {
...ContentNodeToEnqueuedScriptConnectionFragment
}
enqueuedStylesheets {
...ContentNodeToEnqueuedStylesheetConnectionFragment
}
expirationTime
guid
id
image
isComment
isContentNode
isFrontPage
isPostsPage
isPreview
isRestricted
isRevision
isTermNode
language {
...LanguageFragment
}
lastEditedBy {
...ContentNodeToEditLastConnectionEdgeFragment
}
link
modified
modifiedGmt
modules {
... on EventSearch {
...EventSearchFragment
}
... on EventSelected {
...EventSelectedFragment
}
... on EventSearchCarousel {
...EventSearchCarouselFragment
}
... on EventSelectedCarousel {
...EventSelectedCarouselFragment
}
... on LocationsSelected {
...LocationsSelectedFragment
}
... on LocationsSelectedCarousel {
...LocationsSelectedCarouselFragment
}
}
preview {
...CollectionToPreviewConnectionEdgeFragment
}
previewRevisionDatabaseId
previewRevisionId
revisionOf {
...NodeWithRevisionsToContentNodeConnectionEdgeFragment
}
revisions {
...CollectionToRevisionConnectionFragment
}
seo {
...SEOFragment
}
showOnFrontPage
slug
status
template {
...ContentTemplateFragment
}
title
translation {
...CollectionFragment
}
translations {
...CollectionFragment
}
uri
}
}
Variables
{
"id": 4,
"collectionId": 123,
"uri": "xyz789",
"slug": "abc123"
}
Response
{
"data": {
"collectionBy": {
"backgroundColor": "xyz789",
"collectionId": 987,
"contentType": ContentNodeToContentTypeConnectionEdge,
"contentTypeName": "xyz789",
"databaseId": 123,
"date": "xyz789",
"dateGmt": "xyz789",
"description": "xyz789",
"desiredSlug": "xyz789",
"editingLockedBy": ContentNodeToEditLockConnectionEdge,
"enclosure": "xyz789",
"enqueuedScripts": ContentNodeToEnqueuedScriptConnection,
"enqueuedStylesheets": ContentNodeToEnqueuedStylesheetConnection,
"expirationTime": "abc123",
"guid": "abc123",
"id": "4",
"image": "xyz789",
"isComment": true,
"isContentNode": true,
"isFrontPage": false,
"isPostsPage": false,
"isPreview": true,
"isRestricted": false,
"isRevision": false,
"isTermNode": true,
"language": Language,
"lastEditedBy": ContentNodeToEditLastConnectionEdge,
"link": "abc123",
"modified": "xyz789",
"modifiedGmt": "abc123",
"modules": [EventSearch],
"preview": CollectionToPreviewConnectionEdge,
"previewRevisionDatabaseId": 123,
"previewRevisionId": "4",
"revisionOf": NodeWithRevisionsToContentNodeConnectionEdge,
"revisions": CollectionToRevisionConnection,
"seo": SEO,
"showOnFrontPage": true,
"slug": "abc123",
"status": "abc123",
"template": ContentTemplate,
"title": "abc123",
"translation": Collection,
"translations": [Collection],
"uri": "xyz789"
}
}
}
collections
Description
Connection between the RootQuery type and the collection type
Response
Returns a RootQueryToCollectionConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
The number of items to return after the referenced "after" cursor |
last - Int
|
The number of items to return before the referenced "before" cursor |
after - String
|
Cursor used along with the "first" argument to reference where in the dataset to get data |
before - String
|
Cursor used along with the "last" argument to reference where in the dataset to get data |
where - RootQueryToCollectionConnectionWhereArgs
|
Arguments for filtering the connection |
Example
Query
query collections(
$first: Int,
$last: Int,
$after: String,
$before: String,
$where: RootQueryToCollectionConnectionWhereArgs
) {
collections(
first: $first,
last: $last,
after: $after,
before: $before,
where: $where
) {
edges {
...RootQueryToCollectionConnectionEdgeFragment
}
nodes {
...CollectionFragment
}
pageInfo {
...RootQueryToCollectionConnectionPageInfoFragment
}
}
}
Variables
{
"first": 987,
"last": 987,
"after": "abc123",
"before": "abc123",
"where": RootQueryToCollectionConnectionWhereArgs
}
Response
{
"data": {
"collections": {
"edges": [RootQueryToCollectionConnectionEdge],
"nodes": [Collection],
"pageInfo": RootQueryToCollectionConnectionPageInfo
}
}
}
comment
Description
Returns a Comment
Response
Returns a Comment
Arguments
| Name | Description |
|---|---|
id - ID!
|
Unique identifier for the comment node. |
idType - CommentNodeIdTypeEnum
|
Type of unique identifier to fetch a comment by. Default is Global ID |
Example
Query
query comment(
$id: ID!,
$idType: CommentNodeIdTypeEnum
) {
comment(
id: $id,
idType: $idType
) {
agent
approved
author {
...CommentToCommenterConnectionEdgeFragment
}
authorIp
commentId
commentedOn {
...CommentToContentNodeConnectionEdgeFragment
}
content
databaseId
date
dateGmt
id
isComment
isContentNode
isFrontPage
isPostsPage
isRestricted
isTermNode
karma
link
parent {
...CommentToParentCommentConnectionEdgeFragment
}
parentDatabaseId
parentId
replies {
...CommentToCommentConnectionFragment
}
status
type
uri
}
}
Variables
{"id": "4", "idType": "DATABASE_ID"}
Response
{
"data": {
"comment": {
"agent": "xyz789",
"approved": true,
"author": CommentToCommenterConnectionEdge,
"authorIp": "abc123",
"commentId": 987,
"commentedOn": CommentToContentNodeConnectionEdge,
"content": "xyz789",
"databaseId": 987,
"date": "xyz789",
"dateGmt": "xyz789",
"id": "4",
"isComment": true,
"isContentNode": true,
"isFrontPage": false,
"isPostsPage": false,
"isRestricted": true,
"isTermNode": false,
"karma": 987,
"link": "xyz789",
"parent": CommentToParentCommentConnectionEdge,
"parentDatabaseId": 987,
"parentId": 4,
"replies": CommentToCommentConnection,
"status": "APPROVE",
"type": "abc123",
"uri": "xyz789"
}
}
}
comments
Description
Connection between the RootQuery type and the Comment type
Response
Returns a RootQueryToCommentConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
The number of items to return after the referenced "after" cursor |
last - Int
|
The number of items to return before the referenced "before" cursor |
after - String
|
Cursor used along with the "first" argument to reference where in the dataset to get data |
before - String
|
Cursor used along with the "last" argument to reference where in the dataset to get data |
where - RootQueryToCommentConnectionWhereArgs
|
Arguments for filtering the connection |
Example
Query
query comments(
$first: Int,
$last: Int,
$after: String,
$before: String,
$where: RootQueryToCommentConnectionWhereArgs
) {
comments(
first: $first,
last: $last,
after: $after,
before: $before,
where: $where
) {
edges {
...RootQueryToCommentConnectionEdgeFragment
}
nodes {
...CommentFragment
}
pageInfo {
...RootQueryToCommentConnectionPageInfoFragment
}
}
}
Variables
{
"first": 987,
"last": 987,
"after": "xyz789",
"before": "xyz789",
"where": RootQueryToCommentConnectionWhereArgs
}
Response
{
"data": {
"comments": {
"edges": [RootQueryToCommentConnectionEdge],
"nodes": [Comment],
"pageInfo": RootQueryToCommentConnectionPageInfo
}
}
}
contact
Description
An object of the contact Type. Contacts
Response
Returns a Contact
Arguments
| Name | Description |
|---|---|
id - ID!
|
The globally unique identifier of the object. |
idType - ContactIdType
|
Type of unique identifier to fetch by. Default is Global ID |
asPreview - Boolean
|
Whether to return the Preview Node instead of the Published Node. When the ID of a Node is provided along with asPreview being set to true, the preview node with un-published changes will be returned instead of the published node. If no preview node exists or the requester doesn't have proper capabilities to preview, no node will be returned. If the ID provided is a URI and has a preview query arg, it will be used as a fallback if the "asPreview" argument is not explicitly provided as an argument. |
Example
Query
query contact(
$id: ID!,
$idType: ContactIdType,
$asPreview: Boolean
) {
contact(
id: $id,
idType: $idType,
asPreview: $asPreview
) {
contactId
contentType {
...ContentNodeToContentTypeConnectionEdgeFragment
}
contentTypeName
databaseId
date
dateGmt
description
desiredSlug
editingLockedBy {
...ContentNodeToEditLockConnectionEdgeFragment
}
enclosure
enqueuedScripts {
...ContentNodeToEnqueuedScriptConnectionFragment
}
enqueuedStylesheets {
...ContentNodeToEnqueuedStylesheetConnectionFragment
}
featuredImage {
...NodeWithFeaturedImageToMediaItemConnectionEdgeFragment
}
featuredImageDatabaseId
featuredImageId
firstName
guid
id
isComment
isContentNode
isFrontPage
isPostsPage
isPreview
isRestricted
isRevision
isTermNode
jobTitle
language {
...LanguageFragment
}
lastEditedBy {
...ContentNodeToEditLastConnectionEdgeFragment
}
lastName
link
modified
modifiedGmt
preview {
...ContactToPreviewConnectionEdgeFragment
}
previewRevisionDatabaseId
previewRevisionId
revisionOf {
...NodeWithRevisionsToContentNodeConnectionEdgeFragment
}
revisions {
...ContactToRevisionConnectionFragment
}
seo {
...SEOFragment
}
slug
status
template {
...ContentTemplateFragment
}
title
translation {
...ContactFragment
}
translations {
...ContactFragment
}
uri
}
}
Variables
{
"id": "4",
"idType": "DATABASE_ID",
"asPreview": true
}
Response
{
"data": {
"contact": {
"contactId": 123,
"contentType": ContentNodeToContentTypeConnectionEdge,
"contentTypeName": "xyz789",
"databaseId": 123,
"date": "xyz789",
"dateGmt": "abc123",
"description": "xyz789",
"desiredSlug": "abc123",
"editingLockedBy": ContentNodeToEditLockConnectionEdge,
"enclosure": "xyz789",
"enqueuedScripts": ContentNodeToEnqueuedScriptConnection,
"enqueuedStylesheets": ContentNodeToEnqueuedStylesheetConnection,
"featuredImage": NodeWithFeaturedImageToMediaItemConnectionEdge,
"featuredImageDatabaseId": 987,
"featuredImageId": 4,
"firstName": "xyz789",
"guid": "abc123",
"id": 4,
"isComment": true,
"isContentNode": true,
"isFrontPage": false,
"isPostsPage": false,
"isPreview": true,
"isRestricted": true,
"isRevision": true,
"isTermNode": true,
"jobTitle": "xyz789",
"language": Language,
"lastEditedBy": ContentNodeToEditLastConnectionEdge,
"lastName": "abc123",
"link": "xyz789",
"modified": "abc123",
"modifiedGmt": "abc123",
"preview": ContactToPreviewConnectionEdge,
"previewRevisionDatabaseId": 123,
"previewRevisionId": "4",
"revisionOf": NodeWithRevisionsToContentNodeConnectionEdge,
"revisions": ContactToRevisionConnection,
"seo": SEO,
"slug": "xyz789",
"status": "abc123",
"template": ContentTemplate,
"title": "abc123",
"translation": Contact,
"translations": [Contact],
"uri": "abc123"
}
}
}
contactBy
Description
A contact object
Response
Returns a Contact
Example
Query
query contactBy(
$id: ID,
$contactId: Int,
$uri: String,
$slug: String
) {
contactBy(
id: $id,
contactId: $contactId,
uri: $uri,
slug: $slug
) {
contactId
contentType {
...ContentNodeToContentTypeConnectionEdgeFragment
}
contentTypeName
databaseId
date
dateGmt
description
desiredSlug
editingLockedBy {
...ContentNodeToEditLockConnectionEdgeFragment
}
enclosure
enqueuedScripts {
...ContentNodeToEnqueuedScriptConnectionFragment
}
enqueuedStylesheets {
...ContentNodeToEnqueuedStylesheetConnectionFragment
}
featuredImage {
...NodeWithFeaturedImageToMediaItemConnectionEdgeFragment
}
featuredImageDatabaseId
featuredImageId
firstName
guid
id
isComment
isContentNode
isFrontPage
isPostsPage
isPreview
isRestricted
isRevision
isTermNode
jobTitle
language {
...LanguageFragment
}
lastEditedBy {
...ContentNodeToEditLastConnectionEdgeFragment
}
lastName
link
modified
modifiedGmt
preview {
...ContactToPreviewConnectionEdgeFragment
}
previewRevisionDatabaseId
previewRevisionId
revisionOf {
...NodeWithRevisionsToContentNodeConnectionEdgeFragment
}
revisions {
...ContactToRevisionConnectionFragment
}
seo {
...SEOFragment
}
slug
status
template {
...ContentTemplateFragment
}
title
translation {
...ContactFragment
}
translations {
...ContactFragment
}
uri
}
}
Variables
{
"id": 4,
"contactId": 987,
"uri": "xyz789",
"slug": "xyz789"
}
Response
{
"data": {
"contactBy": {
"contactId": 987,
"contentType": ContentNodeToContentTypeConnectionEdge,
"contentTypeName": "abc123",
"databaseId": 123,
"date": "xyz789",
"dateGmt": "xyz789",
"description": "abc123",
"desiredSlug": "xyz789",
"editingLockedBy": ContentNodeToEditLockConnectionEdge,
"enclosure": "abc123",
"enqueuedScripts": ContentNodeToEnqueuedScriptConnection,
"enqueuedStylesheets": ContentNodeToEnqueuedStylesheetConnection,
"featuredImage": NodeWithFeaturedImageToMediaItemConnectionEdge,
"featuredImageDatabaseId": 123,
"featuredImageId": 4,
"firstName": "xyz789",
"guid": "abc123",
"id": 4,
"isComment": false,
"isContentNode": true,
"isFrontPage": true,
"isPostsPage": true,
"isPreview": false,
"isRestricted": false,
"isRevision": false,
"isTermNode": false,
"jobTitle": "abc123",
"language": Language,
"lastEditedBy": ContentNodeToEditLastConnectionEdge,
"lastName": "abc123",
"link": "xyz789",
"modified": "xyz789",
"modifiedGmt": "abc123",
"preview": ContactToPreviewConnectionEdge,
"previewRevisionDatabaseId": 987,
"previewRevisionId": 4,
"revisionOf": NodeWithRevisionsToContentNodeConnectionEdge,
"revisions": ContactToRevisionConnection,
"seo": SEO,
"slug": "abc123",
"status": "abc123",
"template": ContentTemplate,
"title": "abc123",
"translation": Contact,
"translations": [Contact],
"uri": "abc123"
}
}
}
contacts
Description
Connection between the RootQuery type and the contact type
Response
Returns a RootQueryToContactConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
The number of items to return after the referenced "after" cursor |
last - Int
|
The number of items to return before the referenced "before" cursor |
after - String
|
Cursor used along with the "first" argument to reference where in the dataset to get data |
before - String
|
Cursor used along with the "last" argument to reference where in the dataset to get data |
where - RootQueryToContactConnectionWhereArgs
|
Arguments for filtering the connection |
Example
Query
query contacts(
$first: Int,
$last: Int,
$after: String,
$before: String,
$where: RootQueryToContactConnectionWhereArgs
) {
contacts(
first: $first,
last: $last,
after: $after,
before: $before,
where: $where
) {
edges {
...RootQueryToContactConnectionEdgeFragment
}
nodes {
...ContactFragment
}
pageInfo {
...RootQueryToContactConnectionPageInfoFragment
}
}
}
Variables
{
"first": 987,
"last": 987,
"after": "abc123",
"before": "xyz789",
"where": RootQueryToContactConnectionWhereArgs
}
Response
{
"data": {
"contacts": {
"edges": [RootQueryToContactConnectionEdge],
"nodes": [Contact],
"pageInfo": RootQueryToContactConnectionPageInfo
}
}
}
contentNode
Description
A node used to manage content
Response
Returns a ContentNode
Arguments
| Name | Description |
|---|---|
id - ID!
|
Unique identifier for the content node. |
idType - ContentNodeIdTypeEnum
|
Type of unique identifier to fetch a content node by. Default is Global ID |
contentType - ContentTypeEnum
|
The content type the node is used for. Required when idType is set to "name" or "slug" |
asPreview - Boolean
|
Whether to return the Preview Node instead of the Published Node. When the ID of a Node is provided along with asPreview being set to true, the preview node with un-published changes will be returned instead of the published node. If no preview node exists or the requester doesn't have proper capabilities to preview, no node will be returned. If the ID provided is a URI and has a preview query arg, it will be used as a fallback if the "asPreview" argument is not explicitly provided as an argument. |
Example
Query
query contentNode(
$id: ID!,
$idType: ContentNodeIdTypeEnum,
$contentType: ContentTypeEnum,
$asPreview: Boolean
) {
contentNode(
id: $id,
idType: $idType,
contentType: $contentType,
asPreview: $asPreview
) {
contentType {
...ContentNodeToContentTypeConnectionEdgeFragment
}
contentTypeName
databaseId
date
dateGmt
desiredSlug
editingLockedBy {
...ContentNodeToEditLockConnectionEdgeFragment
}
enclosure
enqueuedScripts {
...ContentNodeToEnqueuedScriptConnectionFragment
}
enqueuedStylesheets {
...ContentNodeToEnqueuedStylesheetConnectionFragment
}
guid
id
isComment
isContentNode
isFrontPage
isPostsPage
isPreview
isRestricted
isTermNode
lastEditedBy {
...ContentNodeToEditLastConnectionEdgeFragment
}
link
modified
modifiedGmt
previewRevisionDatabaseId
previewRevisionId
slug
status
template {
...ContentTemplateFragment
}
uri
}
}
Variables
{
"id": 4,
"idType": "DATABASE_ID",
"contentType": "ATTACHMENT",
"asPreview": true
}
Response
{
"data": {
"contentNode": {
"contentType": ContentNodeToContentTypeConnectionEdge,
"contentTypeName": "xyz789",
"databaseId": 987,
"date": "abc123",
"dateGmt": "abc123",
"desiredSlug": "abc123",
"editingLockedBy": ContentNodeToEditLockConnectionEdge,
"enclosure": "abc123",
"enqueuedScripts": ContentNodeToEnqueuedScriptConnection,
"enqueuedStylesheets": ContentNodeToEnqueuedStylesheetConnection,
"guid": "xyz789",
"id": "4",
"isComment": true,
"isContentNode": true,
"isFrontPage": false,
"isPostsPage": false,
"isPreview": false,
"isRestricted": false,
"isTermNode": true,
"lastEditedBy": ContentNodeToEditLastConnectionEdge,
"link": "abc123",
"modified": "xyz789",
"modifiedGmt": "xyz789",
"previewRevisionDatabaseId": 123,
"previewRevisionId": "4",
"slug": "xyz789",
"status": "xyz789",
"template": ContentTemplate,
"uri": "xyz789"
}
}
}
contentNodes
Description
Connection between the RootQuery type and the ContentNode type
Response
Returns a RootQueryToContentNodeConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
The number of items to return after the referenced "after" cursor |
last - Int
|
The number of items to return before the referenced "before" cursor |
after - String
|
Cursor used along with the "first" argument to reference where in the dataset to get data |
before - String
|
Cursor used along with the "last" argument to reference where in the dataset to get data |
where - RootQueryToContentNodeConnectionWhereArgs
|
Arguments for filtering the connection |
Example
Query
query contentNodes(
$first: Int,
$last: Int,
$after: String,
$before: String,
$where: RootQueryToContentNodeConnectionWhereArgs
) {
contentNodes(
first: $first,
last: $last,
after: $after,
before: $before,
where: $where
) {
edges {
...RootQueryToContentNodeConnectionEdgeFragment
}
nodes {
...ContentNodeFragment
}
pageInfo {
...RootQueryToContentNodeConnectionPageInfoFragment
}
}
}
Variables
{
"first": 987,
"last": 123,
"after": "xyz789",
"before": "abc123",
"where": RootQueryToContentNodeConnectionWhereArgs
}
Response
{
"data": {
"contentNodes": {
"edges": [RootQueryToContentNodeConnectionEdge],
"nodes": [ContentNode],
"pageInfo": RootQueryToContentNodeConnectionPageInfo
}
}
}
contentType
Description
Fetch a Content Type node by unique Identifier
Response
Returns a ContentType
Arguments
| Name | Description |
|---|---|
id - ID!
|
Unique Identifier for the Content Type node. |
idType - ContentTypeIdTypeEnum
|
Type of unique identifier to fetch a content type by. Default is Global ID |
Example
Query
query contentType(
$id: ID!,
$idType: ContentTypeIdTypeEnum
) {
contentType(
id: $id,
idType: $idType
) {
canExport
connectedTaxonomies {
...ContentTypeToTaxonomyConnectionFragment
}
contentNodes {
...ContentTypeToContentNodeConnectionFragment
}
deleteWithUser
description
excludeFromSearch
graphqlPluralName
graphqlSingleName
hasArchive
hierarchical
id
isComment
isContentNode
isFrontPage
isPostsPage
isRestricted
isTermNode
label
labels {
...PostTypeLabelDetailsFragment
}
menuIcon
menuPosition
name
public
publiclyQueryable
restBase
restControllerClass
showInAdminBar
showInGraphql
showInMenu
showInNavMenus
showInRest
showUi
uri
}
}
Variables
{"id": 4, "idType": "ID"}
Response
{
"data": {
"contentType": {
"canExport": true,
"connectedTaxonomies": ContentTypeToTaxonomyConnection,
"contentNodes": ContentTypeToContentNodeConnection,
"deleteWithUser": false,
"description": "xyz789",
"excludeFromSearch": true,
"graphqlPluralName": "abc123",
"graphqlSingleName": "abc123",
"hasArchive": true,
"hierarchical": true,
"id": "4",
"isComment": false,
"isContentNode": false,
"isFrontPage": false,
"isPostsPage": false,
"isRestricted": false,
"isTermNode": true,
"label": "abc123",
"labels": PostTypeLabelDetails,
"menuIcon": "abc123",
"menuPosition": 123,
"name": "xyz789",
"public": true,
"publiclyQueryable": false,
"restBase": "abc123",
"restControllerClass": "xyz789",
"showInAdminBar": false,
"showInGraphql": false,
"showInMenu": false,
"showInNavMenus": false,
"showInRest": false,
"showUi": false,
"uri": "xyz789"
}
}
}
contentTypes
Description
Connection between the RootQuery type and the ContentType type
Response
Returns a RootQueryToContentTypeConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
The number of items to return after the referenced "after" cursor |
last - Int
|
The number of items to return before the referenced "before" cursor |
after - String
|
Cursor used along with the "first" argument to reference where in the dataset to get data |
before - String
|
Cursor used along with the "last" argument to reference where in the dataset to get data |
Example
Query
query contentTypes(
$first: Int,
$last: Int,
$after: String,
$before: String
) {
contentTypes(
first: $first,
last: $last,
after: $after,
before: $before
) {
edges {
...RootQueryToContentTypeConnectionEdgeFragment
}
nodes {
...ContentTypeFragment
}
pageInfo {
...RootQueryToContentTypeConnectionPageInfoFragment
}
}
}
Variables
{
"first": 123,
"last": 987,
"after": "xyz789",
"before": "abc123"
}
Response
{
"data": {
"contentTypes": {
"edges": [RootQueryToContentTypeConnectionEdge],
"nodes": [ContentType],
"pageInfo": RootQueryToContentTypeConnectionPageInfo
}
}
}
defaultImages
Description
Default Images
Response
Returns a DefaultImages
Arguments
| Name | Description |
|---|---|
language - String!
|
Example
Query
query defaultImages($language: String!) {
defaultImages(language: $language) {
article
event
hero
page
}
}
Variables
{"language": "abc123"}
Response
{
"data": {
"defaultImages": {
"article": "abc123",
"event": "abc123",
"hero": "xyz789",
"page": "xyz789"
}
}
}
defaultLanguage
Description
Get language list
Response
Returns a Language
Example
Query
query defaultLanguage {
defaultLanguage {
code
homeUrl
id
locale
name
slug
}
}
Response
{
"data": {
"defaultLanguage": {
"code": "EN",
"homeUrl": "xyz789",
"id": "4",
"locale": "abc123",
"name": "xyz789",
"slug": "abc123"
}
}
}
discussionSettings
Description
Fields of the 'DiscussionSettings' settings group
Response
Returns a DiscussionSettings
Example
Query
query discussionSettings {
discussionSettings {
defaultCommentStatus
defaultPingStatus
}
}
Response
{
"data": {
"discussionSettings": {
"defaultCommentStatus": "xyz789",
"defaultPingStatus": "abc123"
}
}
}
generalSettings
Description
Fields of the 'GeneralSettings' settings group
Response
Returns a GeneralSettings
Example
Query
query generalSettings {
generalSettings {
dateFormat
description
language
startOfWeek
timeFormat
timezone
title
url
}
}
Response
{
"data": {
"generalSettings": {
"dateFormat": "xyz789",
"description": "xyz789",
"language": "xyz789",
"startOfWeek": 987,
"timeFormat": "xyz789",
"timezone": "xyz789",
"title": "xyz789",
"url": "abc123"
}
}
}
landingPage
Description
An object of the landingPage Type. Landing Pages
Response
Returns a LandingPage
Arguments
| Name | Description |
|---|---|
id - ID!
|
The globally unique identifier of the object. |
idType - LandingPageIdType
|
Type of unique identifier to fetch by. Default is Global ID |
asPreview - Boolean
|
Whether to return the Preview Node instead of the Published Node. When the ID of a Node is provided along with asPreview being set to true, the preview node with un-published changes will be returned instead of the published node. If no preview node exists or the requester doesn't have proper capabilities to preview, no node will be returned. If the ID provided is a URI and has a preview query arg, it will be used as a fallback if the "asPreview" argument is not explicitly provided as an argument. |
Example
Query
query landingPage(
$id: ID!,
$idType: LandingPageIdType,
$asPreview: Boolean
) {
landingPage(
id: $id,
idType: $idType,
asPreview: $asPreview
) {
backgroundColor
boxColor
contentType {
...ContentNodeToContentTypeConnectionEdgeFragment
}
contentTypeName
databaseId
date
dateGmt
description
desiredSlug
desktopImage {
...LandingPageToMediaItemConnectionFragment
}
editingLockedBy {
...ContentNodeToEditLockConnectionEdgeFragment
}
enclosure
enqueuedScripts {
...ContentNodeToEnqueuedScriptConnectionFragment
}
enqueuedStylesheets {
...ContentNodeToEnqueuedStylesheetConnectionFragment
}
floatImage {
...LandingPageToFloatImageConnectionFragment
}
guid
heroLink
id
isComment
isContentNode
isFrontPage
isPostsPage
isPreview
isRestricted
isRevision
isTermNode
landingPageId
language {
...LanguageFragment
}
lastEditedBy {
...ContentNodeToEditLastConnectionEdgeFragment
}
link
mobileImage {
...LandingPageToMobileImageConnectionFragment
}
modified
modifiedGmt
modules {
... on EventSearch {
...EventSearchFragment
}
... on EventSelected {
...EventSelectedFragment
}
... on EventSearchCarousel {
...EventSearchCarouselFragment
}
... on EventSelectedCarousel {
...EventSelectedCarouselFragment
}
... on LocationsSelected {
...LocationsSelectedFragment
}
... on LocationsSelectedCarousel {
...LocationsSelectedCarouselFragment
}
}
preview {
...LandingPageToPreviewConnectionEdgeFragment
}
previewRevisionDatabaseId
previewRevisionId
revisionOf {
...NodeWithRevisionsToContentNodeConnectionEdgeFragment
}
revisions {
...LandingPageToRevisionConnectionFragment
}
seo {
...SEOFragment
}
slug
status
template {
...ContentTemplateFragment
}
title
translation {
...LandingPageFragment
}
translations {
...LandingPageFragment
}
uri
}
}
Variables
{"id": 4, "idType": "DATABASE_ID", "asPreview": false}
Response
{
"data": {
"landingPage": {
"backgroundColor": "abc123",
"boxColor": "xyz789",
"contentType": ContentNodeToContentTypeConnectionEdge,
"contentTypeName": "abc123",
"databaseId": 987,
"date": "abc123",
"dateGmt": "xyz789",
"description": "xyz789",
"desiredSlug": "abc123",
"desktopImage": LandingPageToMediaItemConnection,
"editingLockedBy": ContentNodeToEditLockConnectionEdge,
"enclosure": "xyz789",
"enqueuedScripts": ContentNodeToEnqueuedScriptConnection,
"enqueuedStylesheets": ContentNodeToEnqueuedStylesheetConnection,
"floatImage": LandingPageToFloatImageConnection,
"guid": "xyz789",
"heroLink": ["xyz789"],
"id": 4,
"isComment": true,
"isContentNode": true,
"isFrontPage": false,
"isPostsPage": false,
"isPreview": true,
"isRestricted": false,
"isRevision": true,
"isTermNode": false,
"landingPageId": 987,
"language": Language,
"lastEditedBy": ContentNodeToEditLastConnectionEdge,
"link": "abc123",
"mobileImage": LandingPageToMobileImageConnection,
"modified": "abc123",
"modifiedGmt": "xyz789",
"modules": [EventSearch],
"preview": LandingPageToPreviewConnectionEdge,
"previewRevisionDatabaseId": 987,
"previewRevisionId": 4,
"revisionOf": NodeWithRevisionsToContentNodeConnectionEdge,
"revisions": LandingPageToRevisionConnection,
"seo": SEO,
"slug": "abc123",
"status": "abc123",
"template": ContentTemplate,
"title": "xyz789",
"translation": LandingPage,
"translations": [LandingPage],
"uri": "abc123"
}
}
}
landingPageBy
Description
A landingPage object
Response
Returns a LandingPage
Example
Query
query landingPageBy(
$id: ID,
$landingPageId: Int,
$uri: String,
$slug: String
) {
landingPageBy(
id: $id,
landingPageId: $landingPageId,
uri: $uri,
slug: $slug
) {
backgroundColor
boxColor
contentType {
...ContentNodeToContentTypeConnectionEdgeFragment
}
contentTypeName
databaseId
date
dateGmt
description
desiredSlug
desktopImage {
...LandingPageToMediaItemConnectionFragment
}
editingLockedBy {
...ContentNodeToEditLockConnectionEdgeFragment
}
enclosure
enqueuedScripts {
...ContentNodeToEnqueuedScriptConnectionFragment
}
enqueuedStylesheets {
...ContentNodeToEnqueuedStylesheetConnectionFragment
}
floatImage {
...LandingPageToFloatImageConnectionFragment
}
guid
heroLink
id
isComment
isContentNode
isFrontPage
isPostsPage
isPreview
isRestricted
isRevision
isTermNode
landingPageId
language {
...LanguageFragment
}
lastEditedBy {
...ContentNodeToEditLastConnectionEdgeFragment
}
link
mobileImage {
...LandingPageToMobileImageConnectionFragment
}
modified
modifiedGmt
modules {
... on EventSearch {
...EventSearchFragment
}
... on EventSelected {
...EventSelectedFragment
}
... on EventSearchCarousel {
...EventSearchCarouselFragment
}
... on EventSelectedCarousel {
...EventSelectedCarouselFragment
}
... on LocationsSelected {
...LocationsSelectedFragment
}
... on LocationsSelectedCarousel {
...LocationsSelectedCarouselFragment
}
}
preview {
...LandingPageToPreviewConnectionEdgeFragment
}
previewRevisionDatabaseId
previewRevisionId
revisionOf {
...NodeWithRevisionsToContentNodeConnectionEdgeFragment
}
revisions {
...LandingPageToRevisionConnectionFragment
}
seo {
...SEOFragment
}
slug
status
template {
...ContentTemplateFragment
}
title
translation {
...LandingPageFragment
}
translations {
...LandingPageFragment
}
uri
}
}
Variables
{
"id": 4,
"landingPageId": 987,
"uri": "abc123",
"slug": "xyz789"
}
Response
{
"data": {
"landingPageBy": {
"backgroundColor": "abc123",
"boxColor": "abc123",
"contentType": ContentNodeToContentTypeConnectionEdge,
"contentTypeName": "xyz789",
"databaseId": 987,
"date": "abc123",
"dateGmt": "xyz789",
"description": "abc123",
"desiredSlug": "xyz789",
"desktopImage": LandingPageToMediaItemConnection,
"editingLockedBy": ContentNodeToEditLockConnectionEdge,
"enclosure": "xyz789",
"enqueuedScripts": ContentNodeToEnqueuedScriptConnection,
"enqueuedStylesheets": ContentNodeToEnqueuedStylesheetConnection,
"floatImage": LandingPageToFloatImageConnection,
"guid": "abc123",
"heroLink": ["xyz789"],
"id": "4",
"isComment": true,
"isContentNode": false,
"isFrontPage": true,
"isPostsPage": false,
"isPreview": true,
"isRestricted": false,
"isRevision": false,
"isTermNode": false,
"landingPageId": 123,
"language": Language,
"lastEditedBy": ContentNodeToEditLastConnectionEdge,
"link": "xyz789",
"mobileImage": LandingPageToMobileImageConnection,
"modified": "xyz789",
"modifiedGmt": "xyz789",
"modules": [EventSearch],
"preview": LandingPageToPreviewConnectionEdge,
"previewRevisionDatabaseId": 987,
"previewRevisionId": "4",
"revisionOf": NodeWithRevisionsToContentNodeConnectionEdge,
"revisions": LandingPageToRevisionConnection,
"seo": SEO,
"slug": "xyz789",
"status": "abc123",
"template": ContentTemplate,
"title": "xyz789",
"translation": LandingPage,
"translations": [LandingPage],
"uri": "abc123"
}
}
}
landingPages
Description
Connection between the RootQuery type and the landingPage type
Response
Returns a RootQueryToLandingPageConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
The number of items to return after the referenced "after" cursor |
last - Int
|
The number of items to return before the referenced "before" cursor |
after - String
|
Cursor used along with the "first" argument to reference where in the dataset to get data |
before - String
|
Cursor used along with the "last" argument to reference where in the dataset to get data |
where - RootQueryToLandingPageConnectionWhereArgs
|
Arguments for filtering the connection |
Example
Query
query landingPages(
$first: Int,
$last: Int,
$after: String,
$before: String,
$where: RootQueryToLandingPageConnectionWhereArgs
) {
landingPages(
first: $first,
last: $last,
after: $after,
before: $before,
where: $where
) {
edges {
...RootQueryToLandingPageConnectionEdgeFragment
}
nodes {
...LandingPageFragment
}
pageInfo {
...RootQueryToLandingPageConnectionPageInfoFragment
}
}
}
Variables
{
"first": 123,
"last": 123,
"after": "abc123",
"before": "abc123",
"where": RootQueryToLandingPageConnectionWhereArgs
}
Response
{
"data": {
"landingPages": {
"edges": [RootQueryToLandingPageConnectionEdge],
"nodes": [LandingPage],
"pageInfo": RootQueryToLandingPageConnectionPageInfo
}
}
}
languages
Description
List available languages
Response
Returns [Language]
Example
Query
query languages {
languages {
code
homeUrl
id
locale
name
slug
}
}
Response
{
"data": {
"languages": [
{
"code": "EN",
"homeUrl": "xyz789",
"id": 4,
"locale": "abc123",
"name": "abc123",
"slug": "xyz789"
}
]
}
}
mediaItem
Description
An object of the mediaItem Type.
Response
Returns a MediaItem
Arguments
| Name | Description |
|---|---|
id - ID!
|
The globally unique identifier of the object. |
idType - MediaItemIdType
|
Type of unique identifier to fetch by. Default is Global ID |
asPreview - Boolean
|
Whether to return the Preview Node instead of the Published Node. When the ID of a Node is provided along with asPreview being set to true, the preview node with un-published changes will be returned instead of the published node. If no preview node exists or the requester doesn't have proper capabilities to preview, no node will be returned. If the ID provided is a URI and has a preview query arg, it will be used as a fallback if the "asPreview" argument is not explicitly provided as an argument. |
Example
Query
query mediaItem(
$id: ID!,
$idType: MediaItemIdType,
$asPreview: Boolean
) {
mediaItem(
id: $id,
idType: $idType,
asPreview: $asPreview
) {
altText
ancestors {
...HierarchicalContentNodeToContentNodeAncestorsConnectionFragment
}
author {
...NodeWithAuthorToUserConnectionEdgeFragment
}
authorDatabaseId
authorId
caption
children {
...HierarchicalContentNodeToContentNodeChildrenConnectionFragment
}
contentType {
...ContentNodeToContentTypeConnectionEdgeFragment
}
contentTypeName
databaseId
date
dateGmt
description
desiredSlug
editingLockedBy {
...ContentNodeToEditLockConnectionEdgeFragment
}
enclosure
enqueuedScripts {
...ContentNodeToEnqueuedScriptConnectionFragment
}
enqueuedStylesheets {
...ContentNodeToEnqueuedStylesheetConnectionFragment
}
fileSize
guid
id
isComment
isContentNode
isFrontPage
isPostsPage
isPreview
isRestricted
isTermNode
language {
...LanguageFragment
}
lastEditedBy {
...ContentNodeToEditLastConnectionEdgeFragment
}
link
mediaDetails {
...MediaDetailsFragment
}
mediaItemId
mediaItemUrl
mediaType
mimeType
modified
modifiedGmt
parent {
...HierarchicalContentNodeToParentContentNodeConnectionEdgeFragment
}
parentDatabaseId
parentId
photographerName
previewRevisionDatabaseId
previewRevisionId
seo {
...SEOFragment
}
sizes
slug
sourceUrl
srcSet
status
template {
...ContentTemplateFragment
}
title
translation {
...MediaItemFragment
}
translations {
...MediaItemFragment
}
uri
}
}
Variables
{
"id": "4",
"idType": "DATABASE_ID",
"asPreview": true
}
Response
{
"data": {
"mediaItem": {
"altText": "abc123",
"ancestors": HierarchicalContentNodeToContentNodeAncestorsConnection,
"author": NodeWithAuthorToUserConnectionEdge,
"authorDatabaseId": 123,
"authorId": 4,
"caption": "abc123",
"children": HierarchicalContentNodeToContentNodeChildrenConnection,
"contentType": ContentNodeToContentTypeConnectionEdge,
"contentTypeName": "abc123",
"databaseId": 987,
"date": "xyz789",
"dateGmt": "abc123",
"description": "abc123",
"desiredSlug": "abc123",
"editingLockedBy": ContentNodeToEditLockConnectionEdge,
"enclosure": "abc123",
"enqueuedScripts": ContentNodeToEnqueuedScriptConnection,
"enqueuedStylesheets": ContentNodeToEnqueuedStylesheetConnection,
"fileSize": 123,
"guid": "xyz789",
"id": "4",
"isComment": true,
"isContentNode": false,
"isFrontPage": true,
"isPostsPage": true,
"isPreview": true,
"isRestricted": false,
"isTermNode": false,
"language": Language,
"lastEditedBy": ContentNodeToEditLastConnectionEdge,
"link": "xyz789",
"mediaDetails": MediaDetails,
"mediaItemId": 123,
"mediaItemUrl": "abc123",
"mediaType": "xyz789",
"mimeType": "xyz789",
"modified": "abc123",
"modifiedGmt": "xyz789",
"parent": HierarchicalContentNodeToParentContentNodeConnectionEdge,
"parentDatabaseId": 987,
"parentId": "4",
"photographerName": "abc123",
"previewRevisionDatabaseId": 123,
"previewRevisionId": 4,
"seo": SEO,
"sizes": "xyz789",
"slug": "xyz789",
"sourceUrl": "xyz789",
"srcSet": "xyz789",
"status": "xyz789",
"template": ContentTemplate,
"title": "xyz789",
"translation": MediaItem,
"translations": [MediaItem],
"uri": "abc123"
}
}
}
mediaItemBy
Description
A mediaItem object
Response
Returns a MediaItem
Example
Query
query mediaItemBy(
$id: ID,
$mediaItemId: Int,
$uri: String,
$slug: String
) {
mediaItemBy(
id: $id,
mediaItemId: $mediaItemId,
uri: $uri,
slug: $slug
) {
altText
ancestors {
...HierarchicalContentNodeToContentNodeAncestorsConnectionFragment
}
author {
...NodeWithAuthorToUserConnectionEdgeFragment
}
authorDatabaseId
authorId
caption
children {
...HierarchicalContentNodeToContentNodeChildrenConnectionFragment
}
contentType {
...ContentNodeToContentTypeConnectionEdgeFragment
}
contentTypeName
databaseId
date
dateGmt
description
desiredSlug
editingLockedBy {
...ContentNodeToEditLockConnectionEdgeFragment
}
enclosure
enqueuedScripts {
...ContentNodeToEnqueuedScriptConnectionFragment
}
enqueuedStylesheets {
...ContentNodeToEnqueuedStylesheetConnectionFragment
}
fileSize
guid
id
isComment
isContentNode
isFrontPage
isPostsPage
isPreview
isRestricted
isTermNode
language {
...LanguageFragment
}
lastEditedBy {
...ContentNodeToEditLastConnectionEdgeFragment
}
link
mediaDetails {
...MediaDetailsFragment
}
mediaItemId
mediaItemUrl
mediaType
mimeType
modified
modifiedGmt
parent {
...HierarchicalContentNodeToParentContentNodeConnectionEdgeFragment
}
parentDatabaseId
parentId
photographerName
previewRevisionDatabaseId
previewRevisionId
seo {
...SEOFragment
}
sizes
slug
sourceUrl
srcSet
status
template {
...ContentTemplateFragment
}
title
translation {
...MediaItemFragment
}
translations {
...MediaItemFragment
}
uri
}
}
Variables
{
"id": "4",
"mediaItemId": 987,
"uri": "abc123",
"slug": "xyz789"
}
Response
{
"data": {
"mediaItemBy": {
"altText": "abc123",
"ancestors": HierarchicalContentNodeToContentNodeAncestorsConnection,
"author": NodeWithAuthorToUserConnectionEdge,
"authorDatabaseId": 123,
"authorId": 4,
"caption": "xyz789",
"children": HierarchicalContentNodeToContentNodeChildrenConnection,
"contentType": ContentNodeToContentTypeConnectionEdge,
"contentTypeName": "abc123",
"databaseId": 987,
"date": "abc123",
"dateGmt": "abc123",
"description": "abc123",
"desiredSlug": "abc123",
"editingLockedBy": ContentNodeToEditLockConnectionEdge,
"enclosure": "abc123",
"enqueuedScripts": ContentNodeToEnqueuedScriptConnection,
"enqueuedStylesheets": ContentNodeToEnqueuedStylesheetConnection,
"fileSize": 987,
"guid": "xyz789",
"id": "4",
"isComment": false,
"isContentNode": false,
"isFrontPage": true,
"isPostsPage": false,
"isPreview": false,
"isRestricted": true,
"isTermNode": false,
"language": Language,
"lastEditedBy": ContentNodeToEditLastConnectionEdge,
"link": "abc123",
"mediaDetails": MediaDetails,
"mediaItemId": 987,
"mediaItemUrl": "xyz789",
"mediaType": "abc123",
"mimeType": "xyz789",
"modified": "xyz789",
"modifiedGmt": "xyz789",
"parent": HierarchicalContentNodeToParentContentNodeConnectionEdge,
"parentDatabaseId": 123,
"parentId": 4,
"photographerName": "xyz789",
"previewRevisionDatabaseId": 123,
"previewRevisionId": "4",
"seo": SEO,
"sizes": "abc123",
"slug": "xyz789",
"sourceUrl": "abc123",
"srcSet": "xyz789",
"status": "xyz789",
"template": ContentTemplate,
"title": "xyz789",
"translation": MediaItem,
"translations": [MediaItem],
"uri": "xyz789"
}
}
}
mediaItems
Description
Connection between the RootQuery type and the mediaItem type
Response
Returns a RootQueryToMediaItemConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
The number of items to return after the referenced "after" cursor |
last - Int
|
The number of items to return before the referenced "before" cursor |
after - String
|
Cursor used along with the "first" argument to reference where in the dataset to get data |
before - String
|
Cursor used along with the "last" argument to reference where in the dataset to get data |
where - RootQueryToMediaItemConnectionWhereArgs
|
Arguments for filtering the connection |
Example
Query
query mediaItems(
$first: Int,
$last: Int,
$after: String,
$before: String,
$where: RootQueryToMediaItemConnectionWhereArgs
) {
mediaItems(
first: $first,
last: $last,
after: $after,
before: $before,
where: $where
) {
edges {
...RootQueryToMediaItemConnectionEdgeFragment
}
nodes {
...MediaItemFragment
}
pageInfo {
...RootQueryToMediaItemConnectionPageInfoFragment
}
}
}
Variables
{
"first": 987,
"last": 123,
"after": "xyz789",
"before": "xyz789",
"where": RootQueryToMediaItemConnectionWhereArgs
}
Response
{
"data": {
"mediaItems": {
"edges": [RootQueryToMediaItemConnectionEdge],
"nodes": [MediaItem],
"pageInfo": RootQueryToMediaItemConnectionPageInfo
}
}
}
node
Description
Fetches an object given its ID
nodeByUri
Description
Fetches an object given its Unique Resource Identifier
Response
Returns a UniformResourceIdentifiable
Arguments
| Name | Description |
|---|---|
uri - String!
|
Unique Resource Identifier in the form of a path or permalink for a node. Ex: "/hello-world" |
Example
Query
query nodeByUri($uri: String!) {
nodeByUri(uri: $uri) {
id
isComment
isContentNode
isFrontPage
isPostsPage
isTermNode
uri
}
}
Variables
{"uri": "xyz789"}
Response
{
"data": {
"nodeByUri": {
"id": "4",
"isComment": true,
"isContentNode": false,
"isFrontPage": true,
"isPostsPage": false,
"isTermNode": true,
"uri": "abc123"
}
}
}
notification
Response
Returns a Notification
Arguments
| Name | Description |
|---|---|
language - String!
|
Example
Query
query notification($language: String!) {
notification(language: $language) {
content
endDate
level
linkText
linkUrl
startDate
title
}
}
Variables
{"language": "xyz789"}
Response
{
"data": {
"notification": {
"content": "xyz789",
"endDate": "xyz789",
"level": "xyz789",
"linkText": "xyz789",
"linkUrl": "xyz789",
"startDate": "abc123",
"title": "xyz789"
}
}
}
page
Description
An object of the page Type.
Response
Returns a Page
Arguments
| Name | Description |
|---|---|
id - ID!
|
The globally unique identifier of the object. |
idType - PageIdType
|
Type of unique identifier to fetch by. Default is Global ID |
asPreview - Boolean
|
Whether to return the Preview Node instead of the Published Node. When the ID of a Node is provided along with asPreview being set to true, the preview node with un-published changes will be returned instead of the published node. If no preview node exists or the requester doesn't have proper capabilities to preview, no node will be returned. If the ID provided is a URI and has a preview query arg, it will be used as a fallback if the "asPreview" argument is not explicitly provided as an argument. |
Example
Query
query page(
$id: ID!,
$idType: PageIdType,
$asPreview: Boolean
) {
page(
id: $id,
idType: $idType,
asPreview: $asPreview
) {
ancestors {
...HierarchicalContentNodeToContentNodeAncestorsConnectionFragment
}
author {
...NodeWithAuthorToUserConnectionEdgeFragment
}
authorDatabaseId
authorId
breadcrumbs {
...BreadcrumbFragment
}
children {
...HierarchicalContentNodeToContentNodeChildrenConnectionFragment
}
content
contentType {
...ContentNodeToContentTypeConnectionEdgeFragment
}
contentTypeName
databaseId
date
dateGmt
desiredSlug
editingLockedBy {
...ContentNodeToEditLockConnectionEdgeFragment
}
enclosure
enqueuedScripts {
...ContentNodeToEnqueuedScriptConnectionFragment
}
enqueuedStylesheets {
...ContentNodeToEnqueuedStylesheetConnectionFragment
}
expirationTime
featuredImage {
...NodeWithFeaturedImageToMediaItemConnectionEdgeFragment
}
featuredImageDatabaseId
featuredImageId
guid
hero {
...HeroFragment
}
id
isComment
isContentNode
isFrontPage
isPostsPage
isPreview
isPrivacyPage
isRestricted
isRevision
isTermNode
language {
...LanguageFragment
}
lastEditedBy {
...ContentNodeToEditLastConnectionEdgeFragment
}
lead
link
menuOrder
modified
modifiedGmt
modules {
... on EventSearch {
...EventSearchFragment
}
... on EventSelected {
...EventSelectedFragment
}
... on EventSearchCarousel {
...EventSearchCarouselFragment
}
... on EventSelectedCarousel {
...EventSelectedCarouselFragment
}
... on LocationsSelected {
...LocationsSelectedFragment
}
... on LocationsSelectedCarousel {
...LocationsSelectedCarouselFragment
}
... on LayoutCollection {
...LayoutCollectionFragment
}
... on LayoutContact {
...LayoutContactFragment
}
... on LayoutArticles {
...LayoutArticlesFragment
}
... on LayoutArticlesCarousel {
...LayoutArticlesCarouselFragment
}
... on LayoutArticleHighlights {
...LayoutArticleHighlightsFragment
}
... on LayoutPages {
...LayoutPagesFragment
}
... on LayoutPagesCarousel {
...LayoutPagesCarouselFragment
}
... on LayoutContent {
...LayoutContentFragment
}
... on LayoutCard {
...LayoutCardFragment
}
... on LayoutImage {
...LayoutImageFragment
}
... on LayoutCards {
...LayoutCardsFragment
}
... on LayoutSteps {
...LayoutStepsFragment
}
... on LayoutImageGallery {
...LayoutImageGalleryFragment
}
... on LayoutSocialMediaFeed {
...LayoutSocialMediaFeedFragment
}
}
pageId
parent {
...HierarchicalContentNodeToParentContentNodeConnectionEdgeFragment
}
parentDatabaseId
parentId
preview {
...PageToPreviewConnectionEdgeFragment
}
previewRevisionDatabaseId
previewRevisionId
revisionOf {
...NodeWithRevisionsToContentNodeConnectionEdgeFragment
}
revisions {
...PageToRevisionConnectionFragment
}
seo {
...SEOFragment
}
showChildPages
sidebar {
... on LayoutLinkList {
...LayoutLinkListFragment
}
... on LayoutArticles {
...LayoutArticlesFragment
}
... on LayoutPages {
...LayoutPagesFragment
}
... on LayoutCards {
...LayoutCardsFragment
}
}
slug
status
template {
...ContentTemplateFragment
}
title
translation {
...PageFragment
}
translations {
...PageFragment
}
uri
}
}
Variables
{"id": 4, "idType": "DATABASE_ID", "asPreview": true}
Response
{
"data": {
"page": {
"ancestors": HierarchicalContentNodeToContentNodeAncestorsConnection,
"author": NodeWithAuthorToUserConnectionEdge,
"authorDatabaseId": 123,
"authorId": "4",
"breadcrumbs": [Breadcrumb],
"children": HierarchicalContentNodeToContentNodeChildrenConnection,
"content": "abc123",
"contentType": ContentNodeToContentTypeConnectionEdge,
"contentTypeName": "abc123",
"databaseId": 123,
"date": "abc123",
"dateGmt": "abc123",
"desiredSlug": "xyz789",
"editingLockedBy": ContentNodeToEditLockConnectionEdge,
"enclosure": "xyz789",
"enqueuedScripts": ContentNodeToEnqueuedScriptConnection,
"enqueuedStylesheets": ContentNodeToEnqueuedStylesheetConnection,
"expirationTime": "xyz789",
"featuredImage": NodeWithFeaturedImageToMediaItemConnectionEdge,
"featuredImageDatabaseId": 123,
"featuredImageId": "4",
"guid": "abc123",
"hero": Hero,
"id": 4,
"isComment": false,
"isContentNode": false,
"isFrontPage": false,
"isPostsPage": false,
"isPreview": true,
"isPrivacyPage": false,
"isRestricted": false,
"isRevision": false,
"isTermNode": true,
"language": Language,
"lastEditedBy": ContentNodeToEditLastConnectionEdge,
"lead": "xyz789",
"link": "xyz789",
"menuOrder": 123,
"modified": "xyz789",
"modifiedGmt": "abc123",
"modules": [EventSearch],
"pageId": 987,
"parent": HierarchicalContentNodeToParentContentNodeConnectionEdge,
"parentDatabaseId": 123,
"parentId": "4",
"preview": PageToPreviewConnectionEdge,
"previewRevisionDatabaseId": 987,
"previewRevisionId": "4",
"revisionOf": NodeWithRevisionsToContentNodeConnectionEdge,
"revisions": PageToRevisionConnection,
"seo": SEO,
"showChildPages": false,
"sidebar": [LayoutLinkList],
"slug": "abc123",
"status": "abc123",
"template": ContentTemplate,
"title": "abc123",
"translation": Page,
"translations": [Page],
"uri": "abc123"
}
}
}
pageBy
Description
A page object
Response
Returns a Page
Example
Query
query pageBy(
$id: ID,
$pageId: Int,
$uri: String
) {
pageBy(
id: $id,
pageId: $pageId,
uri: $uri
) {
ancestors {
...HierarchicalContentNodeToContentNodeAncestorsConnectionFragment
}
author {
...NodeWithAuthorToUserConnectionEdgeFragment
}
authorDatabaseId
authorId
breadcrumbs {
...BreadcrumbFragment
}
children {
...HierarchicalContentNodeToContentNodeChildrenConnectionFragment
}
content
contentType {
...ContentNodeToContentTypeConnectionEdgeFragment
}
contentTypeName
databaseId
date
dateGmt
desiredSlug
editingLockedBy {
...ContentNodeToEditLockConnectionEdgeFragment
}
enclosure
enqueuedScripts {
...ContentNodeToEnqueuedScriptConnectionFragment
}
enqueuedStylesheets {
...ContentNodeToEnqueuedStylesheetConnectionFragment
}
expirationTime
featuredImage {
...NodeWithFeaturedImageToMediaItemConnectionEdgeFragment
}
featuredImageDatabaseId
featuredImageId
guid
hero {
...HeroFragment
}
id
isComment
isContentNode
isFrontPage
isPostsPage
isPreview
isPrivacyPage
isRestricted
isRevision
isTermNode
language {
...LanguageFragment
}
lastEditedBy {
...ContentNodeToEditLastConnectionEdgeFragment
}
lead
link
menuOrder
modified
modifiedGmt
modules {
... on EventSearch {
...EventSearchFragment
}
... on EventSelected {
...EventSelectedFragment
}
... on EventSearchCarousel {
...EventSearchCarouselFragment
}
... on EventSelectedCarousel {
...EventSelectedCarouselFragment
}
... on LocationsSelected {
...LocationsSelectedFragment
}
... on LocationsSelectedCarousel {
...LocationsSelectedCarouselFragment
}
... on LayoutCollection {
...LayoutCollectionFragment
}
... on LayoutContact {
...LayoutContactFragment
}
... on LayoutArticles {
...LayoutArticlesFragment
}
... on LayoutArticlesCarousel {
...LayoutArticlesCarouselFragment
}
... on LayoutArticleHighlights {
...LayoutArticleHighlightsFragment
}
... on LayoutPages {
...LayoutPagesFragment
}
... on LayoutPagesCarousel {
...LayoutPagesCarouselFragment
}
... on LayoutContent {
...LayoutContentFragment
}
... on LayoutCard {
...LayoutCardFragment
}
... on LayoutImage {
...LayoutImageFragment
}
... on LayoutCards {
...LayoutCardsFragment
}
... on LayoutSteps {
...LayoutStepsFragment
}
... on LayoutImageGallery {
...LayoutImageGalleryFragment
}
... on LayoutSocialMediaFeed {
...LayoutSocialMediaFeedFragment
}
}
pageId
parent {
...HierarchicalContentNodeToParentContentNodeConnectionEdgeFragment
}
parentDatabaseId
parentId
preview {
...PageToPreviewConnectionEdgeFragment
}
previewRevisionDatabaseId
previewRevisionId
revisionOf {
...NodeWithRevisionsToContentNodeConnectionEdgeFragment
}
revisions {
...PageToRevisionConnectionFragment
}
seo {
...SEOFragment
}
showChildPages
sidebar {
... on LayoutLinkList {
...LayoutLinkListFragment
}
... on LayoutArticles {
...LayoutArticlesFragment
}
... on LayoutPages {
...LayoutPagesFragment
}
... on LayoutCards {
...LayoutCardsFragment
}
}
slug
status
template {
...ContentTemplateFragment
}
title
translation {
...PageFragment
}
translations {
...PageFragment
}
uri
}
}
Variables
{"id": 4, "pageId": 123, "uri": "abc123"}
Response
{
"data": {
"pageBy": {
"ancestors": HierarchicalContentNodeToContentNodeAncestorsConnection,
"author": NodeWithAuthorToUserConnectionEdge,
"authorDatabaseId": 987,
"authorId": "4",
"breadcrumbs": [Breadcrumb],
"children": HierarchicalContentNodeToContentNodeChildrenConnection,
"content": "abc123",
"contentType": ContentNodeToContentTypeConnectionEdge,
"contentTypeName": "abc123",
"databaseId": 123,
"date": "abc123",
"dateGmt": "xyz789",
"desiredSlug": "abc123",
"editingLockedBy": ContentNodeToEditLockConnectionEdge,
"enclosure": "abc123",
"enqueuedScripts": ContentNodeToEnqueuedScriptConnection,
"enqueuedStylesheets": ContentNodeToEnqueuedStylesheetConnection,
"expirationTime": "abc123",
"featuredImage": NodeWithFeaturedImageToMediaItemConnectionEdge,
"featuredImageDatabaseId": 987,
"featuredImageId": "4",
"guid": "xyz789",
"hero": Hero,
"id": 4,
"isComment": true,
"isContentNode": false,
"isFrontPage": true,
"isPostsPage": false,
"isPreview": true,
"isPrivacyPage": false,
"isRestricted": false,
"isRevision": true,
"isTermNode": true,
"language": Language,
"lastEditedBy": ContentNodeToEditLastConnectionEdge,
"lead": "abc123",
"link": "xyz789",
"menuOrder": 123,
"modified": "abc123",
"modifiedGmt": "abc123",
"modules": [EventSearch],
"pageId": 123,
"parent": HierarchicalContentNodeToParentContentNodeConnectionEdge,
"parentDatabaseId": 123,
"parentId": "4",
"preview": PageToPreviewConnectionEdge,
"previewRevisionDatabaseId": 123,
"previewRevisionId": 4,
"revisionOf": NodeWithRevisionsToContentNodeConnectionEdge,
"revisions": PageToRevisionConnection,
"seo": SEO,
"showChildPages": false,
"sidebar": [LayoutLinkList],
"slug": "abc123",
"status": "xyz789",
"template": ContentTemplate,
"title": "xyz789",
"translation": Page,
"translations": [Page],
"uri": "xyz789"
}
}
}
pageByTemplate
Description
Returns ID of page that uses the given template
Response
Returns a Page
Arguments
| Name | Description |
|---|---|
language - String
|
|
template - TemplateEnum
|
Example
Query
query pageByTemplate(
$language: String,
$template: TemplateEnum
) {
pageByTemplate(
language: $language,
template: $template
) {
ancestors {
...HierarchicalContentNodeToContentNodeAncestorsConnectionFragment
}
author {
...NodeWithAuthorToUserConnectionEdgeFragment
}
authorDatabaseId
authorId
breadcrumbs {
...BreadcrumbFragment
}
children {
...HierarchicalContentNodeToContentNodeChildrenConnectionFragment
}
content
contentType {
...ContentNodeToContentTypeConnectionEdgeFragment
}
contentTypeName
databaseId
date
dateGmt
desiredSlug
editingLockedBy {
...ContentNodeToEditLockConnectionEdgeFragment
}
enclosure
enqueuedScripts {
...ContentNodeToEnqueuedScriptConnectionFragment
}
enqueuedStylesheets {
...ContentNodeToEnqueuedStylesheetConnectionFragment
}
expirationTime
featuredImage {
...NodeWithFeaturedImageToMediaItemConnectionEdgeFragment
}
featuredImageDatabaseId
featuredImageId
guid
hero {
...HeroFragment
}
id
isComment
isContentNode
isFrontPage
isPostsPage
isPreview
isPrivacyPage
isRestricted
isRevision
isTermNode
language {
...LanguageFragment
}
lastEditedBy {
...ContentNodeToEditLastConnectionEdgeFragment
}
lead
link
menuOrder
modified
modifiedGmt
modules {
... on EventSearch {
...EventSearchFragment
}
... on EventSelected {
...EventSelectedFragment
}
... on EventSearchCarousel {
...EventSearchCarouselFragment
}
... on EventSelectedCarousel {
...EventSelectedCarouselFragment
}
... on LocationsSelected {
...LocationsSelectedFragment
}
... on LocationsSelectedCarousel {
...LocationsSelectedCarouselFragment
}
... on LayoutCollection {
...LayoutCollectionFragment
}
... on LayoutContact {
...LayoutContactFragment
}
... on LayoutArticles {
...LayoutArticlesFragment
}
... on LayoutArticlesCarousel {
...LayoutArticlesCarouselFragment
}
... on LayoutArticleHighlights {
...LayoutArticleHighlightsFragment
}
... on LayoutPages {
...LayoutPagesFragment
}
... on LayoutPagesCarousel {
...LayoutPagesCarouselFragment
}
... on LayoutContent {
...LayoutContentFragment
}
... on LayoutCard {
...LayoutCardFragment
}
... on LayoutImage {
...LayoutImageFragment
}
... on LayoutCards {
...LayoutCardsFragment
}
... on LayoutSteps {
...LayoutStepsFragment
}
... on LayoutImageGallery {
...LayoutImageGalleryFragment
}
... on LayoutSocialMediaFeed {
...LayoutSocialMediaFeedFragment
}
}
pageId
parent {
...HierarchicalContentNodeToParentContentNodeConnectionEdgeFragment
}
parentDatabaseId
parentId
preview {
...PageToPreviewConnectionEdgeFragment
}
previewRevisionDatabaseId
previewRevisionId
revisionOf {
...NodeWithRevisionsToContentNodeConnectionEdgeFragment
}
revisions {
...PageToRevisionConnectionFragment
}
seo {
...SEOFragment
}
showChildPages
sidebar {
... on LayoutLinkList {
...LayoutLinkListFragment
}
... on LayoutArticles {
...LayoutArticlesFragment
}
... on LayoutPages {
...LayoutPagesFragment
}
... on LayoutCards {
...LayoutCardsFragment
}
}
slug
status
template {
...ContentTemplateFragment
}
title
translation {
...PageFragment
}
translations {
...PageFragment
}
uri
}
}
Variables
{
"language": "abc123",
"template": "frontPage"
}
Response
{
"data": {
"pageByTemplate": {
"ancestors": HierarchicalContentNodeToContentNodeAncestorsConnection,
"author": NodeWithAuthorToUserConnectionEdge,
"authorDatabaseId": 987,
"authorId": 4,
"breadcrumbs": [Breadcrumb],
"children": HierarchicalContentNodeToContentNodeChildrenConnection,
"content": "xyz789",
"contentType": ContentNodeToContentTypeConnectionEdge,
"contentTypeName": "abc123",
"databaseId": 987,
"date": "abc123",
"dateGmt": "xyz789",
"desiredSlug": "abc123",
"editingLockedBy": ContentNodeToEditLockConnectionEdge,
"enclosure": "xyz789",
"enqueuedScripts": ContentNodeToEnqueuedScriptConnection,
"enqueuedStylesheets": ContentNodeToEnqueuedStylesheetConnection,
"expirationTime": "abc123",
"featuredImage": NodeWithFeaturedImageToMediaItemConnectionEdge,
"featuredImageDatabaseId": 987,
"featuredImageId": "4",
"guid": "abc123",
"hero": Hero,
"id": "4",
"isComment": false,
"isContentNode": false,
"isFrontPage": true,
"isPostsPage": true,
"isPreview": true,
"isPrivacyPage": true,
"isRestricted": false,
"isRevision": false,
"isTermNode": false,
"language": Language,
"lastEditedBy": ContentNodeToEditLastConnectionEdge,
"lead": "abc123",
"link": "abc123",
"menuOrder": 987,
"modified": "abc123",
"modifiedGmt": "xyz789",
"modules": [EventSearch],
"pageId": 987,
"parent": HierarchicalContentNodeToParentContentNodeConnectionEdge,
"parentDatabaseId": 123,
"parentId": "4",
"preview": PageToPreviewConnectionEdge,
"previewRevisionDatabaseId": 123,
"previewRevisionId": "4",
"revisionOf": NodeWithRevisionsToContentNodeConnectionEdge,
"revisions": PageToRevisionConnection,
"seo": SEO,
"showChildPages": true,
"sidebar": [LayoutLinkList],
"slug": "abc123",
"status": "abc123",
"template": ContentTemplate,
"title": "abc123",
"translation": Page,
"translations": [Page],
"uri": "xyz789"
}
}
}
pages
Description
Connection between the RootQuery type and the page type
Response
Returns a RootQueryToPageConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
The number of items to return after the referenced "after" cursor |
last - Int
|
The number of items to return before the referenced "before" cursor |
after - String
|
Cursor used along with the "first" argument to reference where in the dataset to get data |
before - String
|
Cursor used along with the "last" argument to reference where in the dataset to get data |
where - RootQueryToPageConnectionWhereArgs
|
Arguments for filtering the connection |
Example
Query
query pages(
$first: Int,
$last: Int,
$after: String,
$before: String,
$where: RootQueryToPageConnectionWhereArgs
) {
pages(
first: $first,
last: $last,
after: $after,
before: $before,
where: $where
) {
edges {
...RootQueryToPageConnectionEdgeFragment
}
nodes {
...PageFragment
}
pageInfo {
...RootQueryToPageConnectionPageInfoFragment
}
}
}
Variables
{
"first": 987,
"last": 987,
"after": "abc123",
"before": "xyz789",
"where": RootQueryToPageConnectionWhereArgs
}
Response
{
"data": {
"pages": {
"edges": [RootQueryToPageConnectionEdge],
"nodes": [Page],
"pageInfo": RootQueryToPageConnectionPageInfo
}
}
}
plugin
Description
A WordPress plugin
Response
Returns a Plugin
Arguments
| Name | Description |
|---|---|
id - ID!
|
The globally unique identifier of the plugin. |
Example
Query
query plugin($id: ID!) {
plugin(id: $id) {
author
authorUri
description
id
isRestricted
name
path
pluginUri
version
}
}
Variables
{"id": "4"}
Response
{
"data": {
"plugin": {
"author": "xyz789",
"authorUri": "xyz789",
"description": "xyz789",
"id": "4",
"isRestricted": false,
"name": "xyz789",
"path": "abc123",
"pluginUri": "xyz789",
"version": "xyz789"
}
}
}
plugins
Description
Connection between the RootQuery type and the Plugin type
Response
Returns a RootQueryToPluginConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
The number of items to return after the referenced "after" cursor |
last - Int
|
The number of items to return before the referenced "before" cursor |
after - String
|
Cursor used along with the "first" argument to reference where in the dataset to get data |
before - String
|
Cursor used along with the "last" argument to reference where in the dataset to get data |
where - RootQueryToPluginConnectionWhereArgs
|
Arguments for filtering the connection |
Example
Query
query plugins(
$first: Int,
$last: Int,
$after: String,
$before: String,
$where: RootQueryToPluginConnectionWhereArgs
) {
plugins(
first: $first,
last: $last,
after: $after,
before: $before,
where: $where
) {
edges {
...RootQueryToPluginConnectionEdgeFragment
}
nodes {
...PluginFragment
}
pageInfo {
...RootQueryToPluginConnectionPageInfoFragment
}
}
}
Variables
{
"first": 987,
"last": 123,
"after": "xyz789",
"before": "xyz789",
"where": RootQueryToPluginConnectionWhereArgs
}
Response
{
"data": {
"plugins": {
"edges": [RootQueryToPluginConnectionEdge],
"nodes": [Plugin],
"pageInfo": RootQueryToPluginConnectionPageInfo
}
}
}
post
Description
An object of the post Type.
Response
Returns a Post
Arguments
| Name | Description |
|---|---|
id - ID!
|
The globally unique identifier of the object. |
idType - PostIdType
|
Type of unique identifier to fetch by. Default is Global ID |
asPreview - Boolean
|
Whether to return the Preview Node instead of the Published Node. When the ID of a Node is provided along with asPreview being set to true, the preview node with un-published changes will be returned instead of the published node. If no preview node exists or the requester doesn't have proper capabilities to preview, no node will be returned. If the ID provided is a URI and has a preview query arg, it will be used as a fallback if the "asPreview" argument is not explicitly provided as an argument. |
Example
Query
query post(
$id: ID!,
$idType: PostIdType,
$asPreview: Boolean
) {
post(
id: $id,
idType: $idType,
asPreview: $asPreview
) {
author {
...NodeWithAuthorToUserConnectionEdgeFragment
}
authorDatabaseId
authorId
breadcrumbs {
...BreadcrumbFragment
}
categories {
...PostToCategoryConnectionFragment
}
content
contentType {
...ContentNodeToContentTypeConnectionEdgeFragment
}
contentTypeName
databaseId
date
dateGmt
desiredSlug
editingLockedBy {
...ContentNodeToEditLockConnectionEdgeFragment
}
enclosure
enqueuedScripts {
...ContentNodeToEnqueuedScriptConnectionFragment
}
enqueuedStylesheets {
...ContentNodeToEnqueuedStylesheetConnectionFragment
}
expirationTime
featuredImage {
...NodeWithFeaturedImageToMediaItemConnectionEdgeFragment
}
featuredImageDatabaseId
featuredImageId
guid
hidePublishedDate
id
isComment
isContentNode
isFrontPage
isPostsPage
isPreview
isRestricted
isRevision
isSticky
isTermNode
language {
...LanguageFragment
}
lastEditedBy {
...ContentNodeToEditLastConnectionEdgeFragment
}
lead
link
modified
modifiedGmt
modules {
... on EventSearch {
...EventSearchFragment
}
... on EventSelected {
...EventSelectedFragment
}
... on EventSearchCarousel {
...EventSearchCarouselFragment
}
... on EventSelectedCarousel {
...EventSelectedCarouselFragment
}
... on LocationsSelected {
...LocationsSelectedFragment
}
... on LocationsSelectedCarousel {
...LocationsSelectedCarouselFragment
}
... on LayoutCollection {
...LayoutCollectionFragment
}
... on LayoutContact {
...LayoutContactFragment
}
... on LayoutArticles {
...LayoutArticlesFragment
}
... on LayoutArticlesCarousel {
...LayoutArticlesCarouselFragment
}
... on LayoutArticleHighlights {
...LayoutArticleHighlightsFragment
}
... on LayoutPages {
...LayoutPagesFragment
}
... on LayoutPagesCarousel {
...LayoutPagesCarouselFragment
}
... on LayoutContent {
...LayoutContentFragment
}
... on LayoutCard {
...LayoutCardFragment
}
... on LayoutImage {
...LayoutImageFragment
}
... on LayoutCards {
...LayoutCardsFragment
}
... on LayoutSteps {
...LayoutStepsFragment
}
... on LayoutImageGallery {
...LayoutImageGalleryFragment
}
... on LayoutSocialMediaFeed {
...LayoutSocialMediaFeedFragment
}
}
postFormats {
...PostToPostFormatConnectionFragment
}
postId
preview {
...PostToPreviewConnectionEdgeFragment
}
previewRevisionDatabaseId
previewRevisionId
revisionOf {
...NodeWithRevisionsToContentNodeConnectionEdgeFragment
}
revisions {
...PostToRevisionConnectionFragment
}
seo {
...SEOFragment
}
sidebar {
... on LayoutLinkList {
...LayoutLinkListFragment
}
... on LayoutArticles {
...LayoutArticlesFragment
}
... on LayoutPages {
...LayoutPagesFragment
}
... on LayoutCards {
...LayoutCardsFragment
}
}
slug
status
tags {
...PostToTagConnectionFragment
}
template {
...ContentTemplateFragment
}
terms {
...PostToTermNodeConnectionFragment
}
title
translation {
...PostFragment
}
translations {
...PostFragment
}
uri
}
}
Variables
{"id": 4, "idType": "DATABASE_ID", "asPreview": true}
Response
{
"data": {
"post": {
"author": NodeWithAuthorToUserConnectionEdge,
"authorDatabaseId": 987,
"authorId": 4,
"breadcrumbs": [Breadcrumb],
"categories": PostToCategoryConnection,
"content": "xyz789",
"contentType": ContentNodeToContentTypeConnectionEdge,
"contentTypeName": "xyz789",
"databaseId": 123,
"date": "abc123",
"dateGmt": "xyz789",
"desiredSlug": "abc123",
"editingLockedBy": ContentNodeToEditLockConnectionEdge,
"enclosure": "abc123",
"enqueuedScripts": ContentNodeToEnqueuedScriptConnection,
"enqueuedStylesheets": ContentNodeToEnqueuedStylesheetConnection,
"expirationTime": "xyz789",
"featuredImage": NodeWithFeaturedImageToMediaItemConnectionEdge,
"featuredImageDatabaseId": 987,
"featuredImageId": 4,
"guid": "xyz789",
"hidePublishedDate": false,
"id": 4,
"isComment": true,
"isContentNode": false,
"isFrontPage": true,
"isPostsPage": false,
"isPreview": true,
"isRestricted": false,
"isRevision": true,
"isSticky": true,
"isTermNode": false,
"language": Language,
"lastEditedBy": ContentNodeToEditLastConnectionEdge,
"lead": "xyz789",
"link": "abc123",
"modified": "xyz789",
"modifiedGmt": "abc123",
"modules": [EventSearch],
"postFormats": PostToPostFormatConnection,
"postId": 123,
"preview": PostToPreviewConnectionEdge,
"previewRevisionDatabaseId": 123,
"previewRevisionId": "4",
"revisionOf": NodeWithRevisionsToContentNodeConnectionEdge,
"revisions": PostToRevisionConnection,
"seo": SEO,
"sidebar": [LayoutLinkList],
"slug": "xyz789",
"status": "xyz789",
"tags": PostToTagConnection,
"template": ContentTemplate,
"terms": PostToTermNodeConnection,
"title": "xyz789",
"translation": Post,
"translations": [Post],
"uri": "xyz789"
}
}
}
postBy
Description
A post object
Response
Returns a Post
Example
Query
query postBy(
$id: ID,
$postId: Int,
$uri: String,
$slug: String
) {
postBy(
id: $id,
postId: $postId,
uri: $uri,
slug: $slug
) {
author {
...NodeWithAuthorToUserConnectionEdgeFragment
}
authorDatabaseId
authorId
breadcrumbs {
...BreadcrumbFragment
}
categories {
...PostToCategoryConnectionFragment
}
content
contentType {
...ContentNodeToContentTypeConnectionEdgeFragment
}
contentTypeName
databaseId
date
dateGmt
desiredSlug
editingLockedBy {
...ContentNodeToEditLockConnectionEdgeFragment
}
enclosure
enqueuedScripts {
...ContentNodeToEnqueuedScriptConnectionFragment
}
enqueuedStylesheets {
...ContentNodeToEnqueuedStylesheetConnectionFragment
}
expirationTime
featuredImage {
...NodeWithFeaturedImageToMediaItemConnectionEdgeFragment
}
featuredImageDatabaseId
featuredImageId
guid
hidePublishedDate
id
isComment
isContentNode
isFrontPage
isPostsPage
isPreview
isRestricted
isRevision
isSticky
isTermNode
language {
...LanguageFragment
}
lastEditedBy {
...ContentNodeToEditLastConnectionEdgeFragment
}
lead
link
modified
modifiedGmt
modules {
... on EventSearch {
...EventSearchFragment
}
... on EventSelected {
...EventSelectedFragment
}
... on EventSearchCarousel {
...EventSearchCarouselFragment
}
... on EventSelectedCarousel {
...EventSelectedCarouselFragment
}
... on LocationsSelected {
...LocationsSelectedFragment
}
... on LocationsSelectedCarousel {
...LocationsSelectedCarouselFragment
}
... on LayoutCollection {
...LayoutCollectionFragment
}
... on LayoutContact {
...LayoutContactFragment
}
... on LayoutArticles {
...LayoutArticlesFragment
}
... on LayoutArticlesCarousel {
...LayoutArticlesCarouselFragment
}
... on LayoutArticleHighlights {
...LayoutArticleHighlightsFragment
}
... on LayoutPages {
...LayoutPagesFragment
}
... on LayoutPagesCarousel {
...LayoutPagesCarouselFragment
}
... on LayoutContent {
...LayoutContentFragment
}
... on LayoutCard {
...LayoutCardFragment
}
... on LayoutImage {
...LayoutImageFragment
}
... on LayoutCards {
...LayoutCardsFragment
}
... on LayoutSteps {
...LayoutStepsFragment
}
... on LayoutImageGallery {
...LayoutImageGalleryFragment
}
... on LayoutSocialMediaFeed {
...LayoutSocialMediaFeedFragment
}
}
postFormats {
...PostToPostFormatConnectionFragment
}
postId
preview {
...PostToPreviewConnectionEdgeFragment
}
previewRevisionDatabaseId
previewRevisionId
revisionOf {
...NodeWithRevisionsToContentNodeConnectionEdgeFragment
}
revisions {
...PostToRevisionConnectionFragment
}
seo {
...SEOFragment
}
sidebar {
... on LayoutLinkList {
...LayoutLinkListFragment
}
... on LayoutArticles {
...LayoutArticlesFragment
}
... on LayoutPages {
...LayoutPagesFragment
}
... on LayoutCards {
...LayoutCardsFragment
}
}
slug
status
tags {
...PostToTagConnectionFragment
}
template {
...ContentTemplateFragment
}
terms {
...PostToTermNodeConnectionFragment
}
title
translation {
...PostFragment
}
translations {
...PostFragment
}
uri
}
}
Variables
{
"id": "4",
"postId": 987,
"uri": "abc123",
"slug": "xyz789"
}
Response
{
"data": {
"postBy": {
"author": NodeWithAuthorToUserConnectionEdge,
"authorDatabaseId": 123,
"authorId": "4",
"breadcrumbs": [Breadcrumb],
"categories": PostToCategoryConnection,
"content": "abc123",
"contentType": ContentNodeToContentTypeConnectionEdge,
"contentTypeName": "abc123",
"databaseId": 987,
"date": "xyz789",
"dateGmt": "xyz789",
"desiredSlug": "abc123",
"editingLockedBy": ContentNodeToEditLockConnectionEdge,
"enclosure": "abc123",
"enqueuedScripts": ContentNodeToEnqueuedScriptConnection,
"enqueuedStylesheets": ContentNodeToEnqueuedStylesheetConnection,
"expirationTime": "xyz789",
"featuredImage": NodeWithFeaturedImageToMediaItemConnectionEdge,
"featuredImageDatabaseId": 123,
"featuredImageId": 4,
"guid": "abc123",
"hidePublishedDate": true,
"id": "4",
"isComment": false,
"isContentNode": true,
"isFrontPage": false,
"isPostsPage": true,
"isPreview": false,
"isRestricted": true,
"isRevision": true,
"isSticky": true,
"isTermNode": true,
"language": Language,
"lastEditedBy": ContentNodeToEditLastConnectionEdge,
"lead": "abc123",
"link": "xyz789",
"modified": "xyz789",
"modifiedGmt": "xyz789",
"modules": [EventSearch],
"postFormats": PostToPostFormatConnection,
"postId": 123,
"preview": PostToPreviewConnectionEdge,
"previewRevisionDatabaseId": 987,
"previewRevisionId": 4,
"revisionOf": NodeWithRevisionsToContentNodeConnectionEdge,
"revisions": PostToRevisionConnection,
"seo": SEO,
"sidebar": [LayoutLinkList],
"slug": "xyz789",
"status": "xyz789",
"tags": PostToTagConnection,
"template": ContentTemplate,
"terms": PostToTermNodeConnection,
"title": "abc123",
"translation": Post,
"translations": [Post],
"uri": "xyz789"
}
}
}
postFormat
Description
A 0bject
Response
Returns a PostFormat
Arguments
| Name | Description |
|---|---|
id - ID!
|
The globally unique identifier of the object. |
idType - PostFormatIdType
|
Type of unique identifier to fetch by. Default is Global ID |
Example
Query
query postFormat(
$id: ID!,
$idType: PostFormatIdType
) {
postFormat(
id: $id,
idType: $idType
) {
contentNodes {
...PostFormatToContentNodeConnectionFragment
}
count
databaseId
description
enqueuedScripts {
...TermNodeToEnqueuedScriptConnectionFragment
}
enqueuedStylesheets {
...TermNodeToEnqueuedStylesheetConnectionFragment
}
id
isComment
isContentNode
isFrontPage
isPostsPage
isRestricted
isTermNode
link
name
postFormatId
posts {
...PostFormatToPostConnectionFragment
}
slug
taxonomy {
...PostFormatToTaxonomyConnectionEdgeFragment
}
taxonomyName
termGroupId
termTaxonomyId
uri
}
}
Variables
{"id": "4", "idType": "DATABASE_ID"}
Response
{
"data": {
"postFormat": {
"contentNodes": PostFormatToContentNodeConnection,
"count": 123,
"databaseId": 123,
"description": "xyz789",
"enqueuedScripts": TermNodeToEnqueuedScriptConnection,
"enqueuedStylesheets": TermNodeToEnqueuedStylesheetConnection,
"id": 4,
"isComment": true,
"isContentNode": false,
"isFrontPage": false,
"isPostsPage": true,
"isRestricted": true,
"isTermNode": true,
"link": "xyz789",
"name": "xyz789",
"postFormatId": 987,
"posts": PostFormatToPostConnection,
"slug": "xyz789",
"taxonomy": PostFormatToTaxonomyConnectionEdge,
"taxonomyName": "xyz789",
"termGroupId": 123,
"termTaxonomyId": 123,
"uri": "xyz789"
}
}
}
postFormats
Description
Connection between the RootQuery type and the postFormat type
Response
Returns a RootQueryToPostFormatConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
The number of items to return after the referenced "after" cursor |
last - Int
|
The number of items to return before the referenced "before" cursor |
after - String
|
Cursor used along with the "first" argument to reference where in the dataset to get data |
before - String
|
Cursor used along with the "last" argument to reference where in the dataset to get data |
where - RootQueryToPostFormatConnectionWhereArgs
|
Arguments for filtering the connection |
Example
Query
query postFormats(
$first: Int,
$last: Int,
$after: String,
$before: String,
$where: RootQueryToPostFormatConnectionWhereArgs
) {
postFormats(
first: $first,
last: $last,
after: $after,
before: $before,
where: $where
) {
edges {
...RootQueryToPostFormatConnectionEdgeFragment
}
nodes {
...PostFormatFragment
}
pageInfo {
...RootQueryToPostFormatConnectionPageInfoFragment
}
}
}
Variables
{
"first": 987,
"last": 123,
"after": "abc123",
"before": "xyz789",
"where": RootQueryToPostFormatConnectionWhereArgs
}
Response
{
"data": {
"postFormats": {
"edges": [RootQueryToPostFormatConnectionEdge],
"nodes": [PostFormat],
"pageInfo": RootQueryToPostFormatConnectionPageInfo
}
}
}
posts
Description
Connection between the RootQuery type and the post type
Response
Returns a RootQueryToPostConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
The number of items to return after the referenced "after" cursor |
last - Int
|
The number of items to return before the referenced "before" cursor |
after - String
|
Cursor used along with the "first" argument to reference where in the dataset to get data |
before - String
|
Cursor used along with the "last" argument to reference where in the dataset to get data |
where - RootQueryToPostConnectionWhereArgs
|
Arguments for filtering the connection |
Example
Query
query posts(
$first: Int,
$last: Int,
$after: String,
$before: String,
$where: RootQueryToPostConnectionWhereArgs
) {
posts(
first: $first,
last: $last,
after: $after,
before: $before,
where: $where
) {
edges {
...RootQueryToPostConnectionEdgeFragment
}
nodes {
...PostFragment
}
pageInfo {
...RootQueryToPostConnectionPageInfoFragment
}
}
}
Variables
{
"first": 123,
"last": 123,
"after": "xyz789",
"before": "abc123",
"where": RootQueryToPostConnectionWhereArgs
}
Response
{
"data": {
"posts": {
"edges": [RootQueryToPostConnectionEdge],
"nodes": [Post],
"pageInfo": RootQueryToPostConnectionPageInfo
}
}
}
readingSettings
Description
Fields of the 'ReadingSettings' settings group
Response
Returns a ReadingSettings
Example
Query
query readingSettings {
readingSettings {
pageForPosts
pageOnFront
postsPerPage
showOnFront
}
}
Response
{
"data": {
"readingSettings": {
"pageForPosts": 987,
"pageOnFront": 123,
"postsPerPage": 123,
"showOnFront": "abc123"
}
}
}
registeredScripts
Description
Connection between the RootQuery type and the EnqueuedScript type
Response
Returns a RootQueryToEnqueuedScriptConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
The number of items to return after the referenced "after" cursor |
last - Int
|
The number of items to return before the referenced "before" cursor |
after - String
|
Cursor used along with the "first" argument to reference where in the dataset to get data |
before - String
|
Cursor used along with the "last" argument to reference where in the dataset to get data |
Example
Query
query registeredScripts(
$first: Int,
$last: Int,
$after: String,
$before: String
) {
registeredScripts(
first: $first,
last: $last,
after: $after,
before: $before
) {
edges {
...RootQueryToEnqueuedScriptConnectionEdgeFragment
}
nodes {
...EnqueuedScriptFragment
}
pageInfo {
...RootQueryToEnqueuedScriptConnectionPageInfoFragment
}
}
}
Variables
{
"first": 987,
"last": 123,
"after": "xyz789",
"before": "abc123"
}
Response
{
"data": {
"registeredScripts": {
"edges": [RootQueryToEnqueuedScriptConnectionEdge],
"nodes": [EnqueuedScript],
"pageInfo": RootQueryToEnqueuedScriptConnectionPageInfo
}
}
}
registeredStylesheets
Description
Connection between the RootQuery type and the EnqueuedStylesheet type
Response
Returns a RootQueryToEnqueuedStylesheetConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
The number of items to return after the referenced "after" cursor |
last - Int
|
The number of items to return before the referenced "before" cursor |
after - String
|
Cursor used along with the "first" argument to reference where in the dataset to get data |
before - String
|
Cursor used along with the "last" argument to reference where in the dataset to get data |
Example
Query
query registeredStylesheets(
$first: Int,
$last: Int,
$after: String,
$before: String
) {
registeredStylesheets(
first: $first,
last: $last,
after: $after,
before: $before
) {
edges {
...RootQueryToEnqueuedStylesheetConnectionEdgeFragment
}
nodes {
...EnqueuedStylesheetFragment
}
pageInfo {
...RootQueryToEnqueuedStylesheetConnectionPageInfoFragment
}
}
}
Variables
{
"first": 987,
"last": 987,
"after": "abc123",
"before": "xyz789"
}
Response
{
"data": {
"registeredStylesheets": {
"edges": [
RootQueryToEnqueuedStylesheetConnectionEdge
],
"nodes": [EnqueuedStylesheet],
"pageInfo": RootQueryToEnqueuedStylesheetConnectionPageInfo
}
}
}
release
Description
An object of the release Type. Releases
Response
Returns a Release
Arguments
| Name | Description |
|---|---|
id - ID!
|
The globally unique identifier of the object. |
idType - ReleaseIdType
|
Type of unique identifier to fetch by. Default is Global ID |
asPreview - Boolean
|
Whether to return the Preview Node instead of the Published Node. When the ID of a Node is provided along with asPreview being set to true, the preview node with un-published changes will be returned instead of the published node. If no preview node exists or the requester doesn't have proper capabilities to preview, no node will be returned. If the ID provided is a URI and has a preview query arg, it will be used as a fallback if the "asPreview" argument is not explicitly provided as an argument. |
Example
Query
query release(
$id: ID!,
$idType: ReleaseIdType,
$asPreview: Boolean
) {
release(
id: $id,
idType: $idType,
asPreview: $asPreview
) {
content
contentType {
...ContentNodeToContentTypeConnectionEdgeFragment
}
contentTypeName
databaseId
date
dateGmt
desiredSlug
editingLockedBy {
...ContentNodeToEditLockConnectionEdgeFragment
}
enclosure
enqueuedScripts {
...ContentNodeToEnqueuedScriptConnectionFragment
}
enqueuedStylesheets {
...ContentNodeToEnqueuedStylesheetConnectionFragment
}
expirationTime
guid
id
isComment
isContentNode
isFrontPage
isPostsPage
isPreview
isRestricted
isRevision
isTermNode
language {
...LanguageFragment
}
lastEditedBy {
...ContentNodeToEditLastConnectionEdgeFragment
}
link
modified
modifiedGmt
preview {
...ReleaseToPreviewConnectionEdgeFragment
}
previewRevisionDatabaseId
previewRevisionId
releaseId
revisionOf {
...NodeWithRevisionsToContentNodeConnectionEdgeFragment
}
revisions {
...ReleaseToRevisionConnectionFragment
}
seo {
...SEOFragment
}
slug
status
template {
...ContentTemplateFragment
}
title
translation {
...ReleaseFragment
}
translations {
...ReleaseFragment
}
uri
}
}
Variables
{"id": 4, "idType": "DATABASE_ID", "asPreview": true}
Response
{
"data": {
"release": {
"content": "xyz789",
"contentType": ContentNodeToContentTypeConnectionEdge,
"contentTypeName": "xyz789",
"databaseId": 123,
"date": "abc123",
"dateGmt": "abc123",
"desiredSlug": "abc123",
"editingLockedBy": ContentNodeToEditLockConnectionEdge,
"enclosure": "abc123",
"enqueuedScripts": ContentNodeToEnqueuedScriptConnection,
"enqueuedStylesheets": ContentNodeToEnqueuedStylesheetConnection,
"expirationTime": "xyz789",
"guid": "xyz789",
"id": "4",
"isComment": true,
"isContentNode": false,
"isFrontPage": true,
"isPostsPage": true,
"isPreview": false,
"isRestricted": false,
"isRevision": false,
"isTermNode": false,
"language": Language,
"lastEditedBy": ContentNodeToEditLastConnectionEdge,
"link": "abc123",
"modified": "xyz789",
"modifiedGmt": "abc123",
"preview": ReleaseToPreviewConnectionEdge,
"previewRevisionDatabaseId": 123,
"previewRevisionId": "4",
"releaseId": 987,
"revisionOf": NodeWithRevisionsToContentNodeConnectionEdge,
"revisions": ReleaseToRevisionConnection,
"seo": SEO,
"slug": "xyz789",
"status": "xyz789",
"template": ContentTemplate,
"title": "abc123",
"translation": Release,
"translations": [Release],
"uri": "abc123"
}
}
}
releaseBy
Description
A release object
Response
Returns a Release
Example
Query
query releaseBy(
$id: ID,
$releaseId: Int,
$uri: String,
$slug: String
) {
releaseBy(
id: $id,
releaseId: $releaseId,
uri: $uri,
slug: $slug
) {
content
contentType {
...ContentNodeToContentTypeConnectionEdgeFragment
}
contentTypeName
databaseId
date
dateGmt
desiredSlug
editingLockedBy {
...ContentNodeToEditLockConnectionEdgeFragment
}
enclosure
enqueuedScripts {
...ContentNodeToEnqueuedScriptConnectionFragment
}
enqueuedStylesheets {
...ContentNodeToEnqueuedStylesheetConnectionFragment
}
expirationTime
guid
id
isComment
isContentNode
isFrontPage
isPostsPage
isPreview
isRestricted
isRevision
isTermNode
language {
...LanguageFragment
}
lastEditedBy {
...ContentNodeToEditLastConnectionEdgeFragment
}
link
modified
modifiedGmt
preview {
...ReleaseToPreviewConnectionEdgeFragment
}
previewRevisionDatabaseId
previewRevisionId
releaseId
revisionOf {
...NodeWithRevisionsToContentNodeConnectionEdgeFragment
}
revisions {
...ReleaseToRevisionConnectionFragment
}
seo {
...SEOFragment
}
slug
status
template {
...ContentTemplateFragment
}
title
translation {
...ReleaseFragment
}
translations {
...ReleaseFragment
}
uri
}
}
Variables
{
"id": 4,
"releaseId": 987,
"uri": "xyz789",
"slug": "xyz789"
}
Response
{
"data": {
"releaseBy": {
"content": "abc123",
"contentType": ContentNodeToContentTypeConnectionEdge,
"contentTypeName": "abc123",
"databaseId": 987,
"date": "xyz789",
"dateGmt": "abc123",
"desiredSlug": "xyz789",
"editingLockedBy": ContentNodeToEditLockConnectionEdge,
"enclosure": "xyz789",
"enqueuedScripts": ContentNodeToEnqueuedScriptConnection,
"enqueuedStylesheets": ContentNodeToEnqueuedStylesheetConnection,
"expirationTime": "xyz789",
"guid": "abc123",
"id": "4",
"isComment": false,
"isContentNode": false,
"isFrontPage": false,
"isPostsPage": true,
"isPreview": true,
"isRestricted": false,
"isRevision": true,
"isTermNode": false,
"language": Language,
"lastEditedBy": ContentNodeToEditLastConnectionEdge,
"link": "abc123",
"modified": "abc123",
"modifiedGmt": "abc123",
"preview": ReleaseToPreviewConnectionEdge,
"previewRevisionDatabaseId": 123,
"previewRevisionId": "4",
"releaseId": 123,
"revisionOf": NodeWithRevisionsToContentNodeConnectionEdge,
"revisions": ReleaseToRevisionConnection,
"seo": SEO,
"slug": "xyz789",
"status": "xyz789",
"template": ContentTemplate,
"title": "xyz789",
"translation": Release,
"translations": [Release],
"uri": "xyz789"
}
}
}
releases
Description
Connection between the RootQuery type and the release type
Response
Returns a RootQueryToReleaseConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
The number of items to return after the referenced "after" cursor |
last - Int
|
The number of items to return before the referenced "before" cursor |
after - String
|
Cursor used along with the "first" argument to reference where in the dataset to get data |
before - String
|
Cursor used along with the "last" argument to reference where in the dataset to get data |
where - RootQueryToReleaseConnectionWhereArgs
|
Arguments for filtering the connection |
Example
Query
query releases(
$first: Int,
$last: Int,
$after: String,
$before: String,
$where: RootQueryToReleaseConnectionWhereArgs
) {
releases(
first: $first,
last: $last,
after: $after,
before: $before,
where: $where
) {
edges {
...RootQueryToReleaseConnectionEdgeFragment
}
nodes {
...ReleaseFragment
}
pageInfo {
...RootQueryToReleaseConnectionPageInfoFragment
}
}
}
Variables
{
"first": 123,
"last": 987,
"after": "abc123",
"before": "abc123",
"where": RootQueryToReleaseConnectionWhereArgs
}
Response
{
"data": {
"releases": {
"edges": [RootQueryToReleaseConnectionEdge],
"nodes": [Release],
"pageInfo": RootQueryToReleaseConnectionPageInfo
}
}
}
revisions
Description
Connection between the RootQuery type and the ContentNode type
Response
Returns a RootQueryToRevisionsConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
The number of items to return after the referenced "after" cursor |
last - Int
|
The number of items to return before the referenced "before" cursor |
after - String
|
Cursor used along with the "first" argument to reference where in the dataset to get data |
before - String
|
Cursor used along with the "last" argument to reference where in the dataset to get data |
where - RootQueryToRevisionsConnectionWhereArgs
|
Arguments for filtering the connection |
Example
Query
query revisions(
$first: Int,
$last: Int,
$after: String,
$before: String,
$where: RootQueryToRevisionsConnectionWhereArgs
) {
revisions(
first: $first,
last: $last,
after: $after,
before: $before,
where: $where
) {
edges {
...RootQueryToRevisionsConnectionEdgeFragment
}
nodes {
...ContentNodeFragment
}
pageInfo {
...RootQueryToRevisionsConnectionPageInfoFragment
}
}
}
Variables
{
"first": 123,
"last": 987,
"after": "xyz789",
"before": "xyz789",
"where": RootQueryToRevisionsConnectionWhereArgs
}
Response
{
"data": {
"revisions": {
"edges": [RootQueryToRevisionsConnectionEdge],
"nodes": [ContentNode],
"pageInfo": RootQueryToRevisionsConnectionPageInfo
}
}
}
seoSettings
Description
The SEO Framework settings
Response
Returns a SeoSettings
Example
Query
query seoSettings {
seoSettings {
separator
}
}
Response
{
"data": {
"seoSettings": {"separator": "xyz789"}
}
}
siteSettings
Description
Site Settings
Response
Returns a SiteSettings
Arguments
| Name | Description |
|---|---|
language - String!
|
Example
Query
query siteSettings($language: String!) {
siteSettings(language: $language) {
logo
siteName
}
}
Variables
{"language": "abc123"}
Response
{
"data": {
"siteSettings": {
"logo": "abc123",
"siteName": "abc123"
}
}
}
tag
Description
A 0bject
Response
Returns a Tag
Example
Query
query tag(
$id: ID!,
$idType: TagIdType
) {
tag(
id: $id,
idType: $idType
) {
contentNodes {
...TagToContentNodeConnectionFragment
}
count
databaseId
description
enqueuedScripts {
...TermNodeToEnqueuedScriptConnectionFragment
}
enqueuedStylesheets {
...TermNodeToEnqueuedStylesheetConnectionFragment
}
id
isComment
isContentNode
isFrontPage
isPostsPage
isRestricted
isTermNode
language {
...LanguageFragment
}
link
name
posts {
...TagToPostConnectionFragment
}
slug
tagId
taxonomy {
...TagToTaxonomyConnectionEdgeFragment
}
taxonomyName
termGroupId
termTaxonomyId
translation {
...TagFragment
}
translations {
...TagFragment
}
uri
}
}
Variables
{"id": "4", "idType": "DATABASE_ID"}
Response
{
"data": {
"tag": {
"contentNodes": TagToContentNodeConnection,
"count": 123,
"databaseId": 987,
"description": "xyz789",
"enqueuedScripts": TermNodeToEnqueuedScriptConnection,
"enqueuedStylesheets": TermNodeToEnqueuedStylesheetConnection,
"id": 4,
"isComment": true,
"isContentNode": true,
"isFrontPage": true,
"isPostsPage": true,
"isRestricted": false,
"isTermNode": true,
"language": Language,
"link": "xyz789",
"name": "abc123",
"posts": TagToPostConnection,
"slug": "xyz789",
"tagId": 987,
"taxonomy": TagToTaxonomyConnectionEdge,
"taxonomyName": "abc123",
"termGroupId": 123,
"termTaxonomyId": 123,
"translation": Tag,
"translations": [Tag],
"uri": "xyz789"
}
}
}
taxonomies
Description
Connection between the RootQuery type and the Taxonomy type
Response
Returns a RootQueryToTaxonomyConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
The number of items to return after the referenced "after" cursor |
last - Int
|
The number of items to return before the referenced "before" cursor |
after - String
|
Cursor used along with the "first" argument to reference where in the dataset to get data |
before - String
|
Cursor used along with the "last" argument to reference where in the dataset to get data |
Example
Query
query taxonomies(
$first: Int,
$last: Int,
$after: String,
$before: String
) {
taxonomies(
first: $first,
last: $last,
after: $after,
before: $before
) {
edges {
...RootQueryToTaxonomyConnectionEdgeFragment
}
nodes {
...TaxonomyFragment
}
pageInfo {
...RootQueryToTaxonomyConnectionPageInfoFragment
}
}
}
Variables
{
"first": 987,
"last": 987,
"after": "abc123",
"before": "abc123"
}
Response
{
"data": {
"taxonomies": {
"edges": [RootQueryToTaxonomyConnectionEdge],
"nodes": [Taxonomy],
"pageInfo": RootQueryToTaxonomyConnectionPageInfo
}
}
}
taxonomy
Description
Fetch a Taxonomy node by unique Identifier
Response
Returns a Taxonomy
Arguments
| Name | Description |
|---|---|
id - ID!
|
Unique Identifier for the Taxonomy node. |
idType - TaxonomyIdTypeEnum
|
Type of unique identifier to fetch a taxonomy by. Default is Global ID |
Example
Query
query taxonomy(
$id: ID!,
$idType: TaxonomyIdTypeEnum
) {
taxonomy(
id: $id,
idType: $idType
) {
connectedContentTypes {
...TaxonomyToContentTypeConnectionFragment
}
connectedTerms {
...TaxonomyToTermNodeConnectionFragment
}
description
graphqlPluralName
graphqlSingleName
hierarchical
id
isRestricted
label
name
public
restBase
restControllerClass
showCloud
showInAdminColumn
showInGraphql
showInMenu
showInNavMenus
showInQuickEdit
showInRest
showUi
}
}
Variables
{"id": "4", "idType": "ID"}
Response
{
"data": {
"taxonomy": {
"connectedContentTypes": TaxonomyToContentTypeConnection,
"connectedTerms": TaxonomyToTermNodeConnection,
"description": "xyz789",
"graphqlPluralName": "xyz789",
"graphqlSingleName": "xyz789",
"hierarchical": true,
"id": 4,
"isRestricted": false,
"label": "abc123",
"name": "xyz789",
"public": true,
"restBase": "xyz789",
"restControllerClass": "xyz789",
"showCloud": true,
"showInAdminColumn": false,
"showInGraphql": true,
"showInMenu": true,
"showInNavMenus": false,
"showInQuickEdit": true,
"showInRest": false,
"showUi": true
}
}
}
termNode
Description
A node in a taxonomy used to group and relate content nodes
Response
Returns a TermNode
Arguments
| Name | Description |
|---|---|
id - ID!
|
Unique identifier for the term node. |
idType - TermNodeIdTypeEnum
|
Type of unique identifier to fetch a term node by. Default is Global ID |
taxonomy - TaxonomyEnum
|
The taxonomy of the tern node. Required when idType is set to "name" or "slug" |
Example
Query
query termNode(
$id: ID!,
$idType: TermNodeIdTypeEnum,
$taxonomy: TaxonomyEnum
) {
termNode(
id: $id,
idType: $idType,
taxonomy: $taxonomy
) {
count
databaseId
description
enqueuedScripts {
...TermNodeToEnqueuedScriptConnectionFragment
}
enqueuedStylesheets {
...TermNodeToEnqueuedStylesheetConnectionFragment
}
id
isComment
isContentNode
isFrontPage
isPostsPage
isRestricted
isTermNode
link
name
slug
taxonomyName
termGroupId
termTaxonomyId
uri
}
}
Variables
{
"id": "4",
"idType": "DATABASE_ID",
"taxonomy": "CATEGORY"
}
Response
{
"data": {
"termNode": {
"count": 987,
"databaseId": 123,
"description": "abc123",
"enqueuedScripts": TermNodeToEnqueuedScriptConnection,
"enqueuedStylesheets": TermNodeToEnqueuedStylesheetConnection,
"id": "4",
"isComment": false,
"isContentNode": false,
"isFrontPage": true,
"isPostsPage": true,
"isRestricted": true,
"isTermNode": false,
"link": "xyz789",
"name": "xyz789",
"slug": "xyz789",
"taxonomyName": "abc123",
"termGroupId": 987,
"termTaxonomyId": 987,
"uri": "xyz789"
}
}
}
terms
Description
Connection between the RootQuery type and the TermNode type
Response
Returns a RootQueryToTermNodeConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
The number of items to return after the referenced "after" cursor |
last - Int
|
The number of items to return before the referenced "before" cursor |
after - String
|
Cursor used along with the "first" argument to reference where in the dataset to get data |
before - String
|
Cursor used along with the "last" argument to reference where in the dataset to get data |
where - RootQueryToTermNodeConnectionWhereArgs
|
Arguments for filtering the connection |
Example
Query
query terms(
$first: Int,
$last: Int,
$after: String,
$before: String,
$where: RootQueryToTermNodeConnectionWhereArgs
) {
terms(
first: $first,
last: $last,
after: $after,
before: $before,
where: $where
) {
edges {
...RootQueryToTermNodeConnectionEdgeFragment
}
nodes {
...TermNodeFragment
}
pageInfo {
...RootQueryToTermNodeConnectionPageInfoFragment
}
}
}
Variables
{
"first": 987,
"last": 987,
"after": "abc123",
"before": "xyz789",
"where": RootQueryToTermNodeConnectionWhereArgs
}
Response
{
"data": {
"terms": {
"edges": [RootQueryToTermNodeConnectionEdge],
"nodes": [TermNode],
"pageInfo": RootQueryToTermNodeConnectionPageInfo
}
}
}
theme
Description
A Theme object
Response
Returns a Theme
Arguments
| Name | Description |
|---|---|
id - ID!
|
The globally unique identifier of the theme. |
Example
Query
query theme($id: ID!) {
theme(id: $id) {
author
authorUri
description
id
isRestricted
name
screenshot
slug
tags
themeUri
version
}
}
Variables
{"id": 4}
Response
{
"data": {
"theme": {
"author": "xyz789",
"authorUri": "abc123",
"description": "xyz789",
"id": "4",
"isRestricted": false,
"name": "xyz789",
"screenshot": "abc123",
"slug": "abc123",
"tags": ["xyz789"],
"themeUri": "xyz789",
"version": "abc123"
}
}
}
themes
Description
Connection between the RootQuery type and the Theme type
Response
Returns a RootQueryToThemeConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
The number of items to return after the referenced "after" cursor |
last - Int
|
The number of items to return before the referenced "before" cursor |
after - String
|
Cursor used along with the "first" argument to reference where in the dataset to get data |
before - String
|
Cursor used along with the "last" argument to reference where in the dataset to get data |
Example
Query
query themes(
$first: Int,
$last: Int,
$after: String,
$before: String
) {
themes(
first: $first,
last: $last,
after: $after,
before: $before
) {
edges {
...RootQueryToThemeConnectionEdgeFragment
}
nodes {
...ThemeFragment
}
pageInfo {
...RootQueryToThemeConnectionPageInfoFragment
}
}
}
Variables
{
"first": 987,
"last": 123,
"after": "xyz789",
"before": "abc123"
}
Response
{
"data": {
"themes": {
"edges": [RootQueryToThemeConnectionEdge],
"nodes": [Theme],
"pageInfo": RootQueryToThemeConnectionPageInfo
}
}
}
translateString
Description
Translate string using pll_translate_string() (Polylang)
Response
Returns a String
Arguments
| Name | Description |
|---|---|
string - String!
|
|
language - LanguageCodeEnum!
|
Example
Query
query translateString(
$string: String!,
$language: LanguageCodeEnum!
) {
translateString(
string: $string,
language: $language
)
}
Variables
{"string": "xyz789", "language": "EN"}
Response
{"data": {"translateString": "abc123"}}
translation
Description
An object of the translation Type. Translations
Response
Returns a Translation
Arguments
| Name | Description |
|---|---|
id - ID!
|
The globally unique identifier of the object. |
idType - TranslationIdType
|
Type of unique identifier to fetch by. Default is Global ID |
asPreview - Boolean
|
Whether to return the Preview Node instead of the Published Node. When the ID of a Node is provided along with asPreview being set to true, the preview node with un-published changes will be returned instead of the published node. If no preview node exists or the requester doesn't have proper capabilities to preview, no node will be returned. If the ID provided is a URI and has a preview query arg, it will be used as a fallback if the "asPreview" argument is not explicitly provided as an argument. |
Example
Query
query translation(
$id: ID!,
$idType: TranslationIdType,
$asPreview: Boolean
) {
translation(
id: $id,
idType: $idType,
asPreview: $asPreview
) {
contentType {
...ContentNodeToContentTypeConnectionEdgeFragment
}
contentTypeName
databaseId
date
dateGmt
desiredSlug
editingLockedBy {
...ContentNodeToEditLockConnectionEdgeFragment
}
enclosure
enqueuedScripts {
...ContentNodeToEnqueuedScriptConnectionFragment
}
enqueuedStylesheets {
...ContentNodeToEnqueuedStylesheetConnectionFragment
}
guid
id
isComment
isContentNode
isFrontPage
isPostsPage
isPreview
isRestricted
isRevision
isTermNode
lastEditedBy {
...ContentNodeToEditLastConnectionEdgeFragment
}
link
modified
modifiedGmt
preview {
...TranslationToPreviewConnectionEdgeFragment
}
previewRevisionDatabaseId
previewRevisionId
revisionOf {
...NodeWithRevisionsToContentNodeConnectionEdgeFragment
}
revisions {
...TranslationToRevisionConnectionFragment
}
seo {
...SEOFragment
}
slug
status
template {
...ContentTemplateFragment
}
title
translationId
translations {
...TranslationResponseFragment
}
uri
}
}
Variables
{
"id": "4",
"idType": "DATABASE_ID",
"asPreview": false
}
Response
{
"data": {
"translation": {
"contentType": ContentNodeToContentTypeConnectionEdge,
"contentTypeName": "xyz789",
"databaseId": 987,
"date": "abc123",
"dateGmt": "abc123",
"desiredSlug": "abc123",
"editingLockedBy": ContentNodeToEditLockConnectionEdge,
"enclosure": "abc123",
"enqueuedScripts": ContentNodeToEnqueuedScriptConnection,
"enqueuedStylesheets": ContentNodeToEnqueuedStylesheetConnection,
"guid": "xyz789",
"id": "4",
"isComment": true,
"isContentNode": false,
"isFrontPage": false,
"isPostsPage": true,
"isPreview": false,
"isRestricted": true,
"isRevision": true,
"isTermNode": false,
"lastEditedBy": ContentNodeToEditLastConnectionEdge,
"link": "xyz789",
"modified": "abc123",
"modifiedGmt": "xyz789",
"preview": TranslationToPreviewConnectionEdge,
"previewRevisionDatabaseId": 987,
"previewRevisionId": 4,
"revisionOf": NodeWithRevisionsToContentNodeConnectionEdge,
"revisions": TranslationToRevisionConnection,
"seo": SEO,
"slug": "abc123",
"status": "xyz789",
"template": ContentTemplate,
"title": "xyz789",
"translationId": 987,
"translations": [TranslationResponse],
"uri": "xyz789"
}
}
}
translationBy
Description
A translation object
Response
Returns a Translation
Example
Query
query translationBy(
$id: ID,
$translationId: Int,
$uri: String,
$slug: String
) {
translationBy(
id: $id,
translationId: $translationId,
uri: $uri,
slug: $slug
) {
contentType {
...ContentNodeToContentTypeConnectionEdgeFragment
}
contentTypeName
databaseId
date
dateGmt
desiredSlug
editingLockedBy {
...ContentNodeToEditLockConnectionEdgeFragment
}
enclosure
enqueuedScripts {
...ContentNodeToEnqueuedScriptConnectionFragment
}
enqueuedStylesheets {
...ContentNodeToEnqueuedStylesheetConnectionFragment
}
guid
id
isComment
isContentNode
isFrontPage
isPostsPage
isPreview
isRestricted
isRevision
isTermNode
lastEditedBy {
...ContentNodeToEditLastConnectionEdgeFragment
}
link
modified
modifiedGmt
preview {
...TranslationToPreviewConnectionEdgeFragment
}
previewRevisionDatabaseId
previewRevisionId
revisionOf {
...NodeWithRevisionsToContentNodeConnectionEdgeFragment
}
revisions {
...TranslationToRevisionConnectionFragment
}
seo {
...SEOFragment
}
slug
status
template {
...ContentTemplateFragment
}
title
translationId
translations {
...TranslationResponseFragment
}
uri
}
}
Variables
{
"id": "4",
"translationId": 987,
"uri": "xyz789",
"slug": "xyz789"
}
Response
{
"data": {
"translationBy": {
"contentType": ContentNodeToContentTypeConnectionEdge,
"contentTypeName": "abc123",
"databaseId": 123,
"date": "xyz789",
"dateGmt": "abc123",
"desiredSlug": "abc123",
"editingLockedBy": ContentNodeToEditLockConnectionEdge,
"enclosure": "abc123",
"enqueuedScripts": ContentNodeToEnqueuedScriptConnection,
"enqueuedStylesheets": ContentNodeToEnqueuedStylesheetConnection,
"guid": "xyz789",
"id": "4",
"isComment": true,
"isContentNode": false,
"isFrontPage": true,
"isPostsPage": true,
"isPreview": true,
"isRestricted": false,
"isRevision": false,
"isTermNode": false,
"lastEditedBy": ContentNodeToEditLastConnectionEdge,
"link": "xyz789",
"modified": "abc123",
"modifiedGmt": "xyz789",
"preview": TranslationToPreviewConnectionEdge,
"previewRevisionDatabaseId": 123,
"previewRevisionId": 4,
"revisionOf": NodeWithRevisionsToContentNodeConnectionEdge,
"revisions": TranslationToRevisionConnection,
"seo": SEO,
"slug": "abc123",
"status": "xyz789",
"template": ContentTemplate,
"title": "abc123",
"translationId": 987,
"translations": [TranslationResponse],
"uri": "xyz789"
}
}
}
translations
Description
Connection between the RootQuery type and the translation type
Response
Returns a RootQueryToTranslationConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
The number of items to return after the referenced "after" cursor |
last - Int
|
The number of items to return before the referenced "before" cursor |
after - String
|
Cursor used along with the "first" argument to reference where in the dataset to get data |
before - String
|
Cursor used along with the "last" argument to reference where in the dataset to get data |
where - RootQueryToTranslationConnectionWhereArgs
|
Arguments for filtering the connection |
Example
Query
query translations(
$first: Int,
$last: Int,
$after: String,
$before: String,
$where: RootQueryToTranslationConnectionWhereArgs
) {
translations(
first: $first,
last: $last,
after: $after,
before: $before,
where: $where
) {
edges {
...RootQueryToTranslationConnectionEdgeFragment
}
nodes {
...TranslationFragment
}
pageInfo {
...RootQueryToTranslationConnectionPageInfoFragment
}
}
}
Variables
{
"first": 123,
"last": 123,
"after": "abc123",
"before": "abc123",
"where": RootQueryToTranslationConnectionWhereArgs
}
Response
{
"data": {
"translations": {
"edges": [RootQueryToTranslationConnectionEdge],
"nodes": [Translation],
"pageInfo": RootQueryToTranslationConnectionPageInfo
}
}
}
user
Description
Returns a user
Response
Returns a User
Arguments
| Name | Description |
|---|---|
id - ID!
|
The globally unique identifier of the user. |
idType - UserNodeIdTypeEnum
|
Type of unique identifier to fetch a user by. Default is Global ID |
Example
Query
query user(
$id: ID!,
$idType: UserNodeIdTypeEnum
) {
user(
id: $id,
idType: $idType
) {
avatar {
...AvatarFragment
}
capKey
capabilities
comments {
...UserToCommentConnectionFragment
}
databaseId
description
email
enqueuedScripts {
...UserToEnqueuedScriptConnectionFragment
}
enqueuedStylesheets {
...UserToEnqueuedStylesheetConnectionFragment
}
extraCapabilities
firstName
id
isComment
isContentNode
isFrontPage
isPostsPage
isRestricted
isTermNode
lastName
locale
mediaItems {
...UserToMediaItemConnectionFragment
}
name
nicename
nickname
pages {
...UserToPageConnectionFragment
}
posts {
...UserToPostConnectionFragment
}
registeredDate
revisions {
...UserToRevisionsConnectionFragment
}
roles {
...UserToUserRoleConnectionFragment
}
shouldShowAdminToolbar
slug
uri
url
userId
username
}
}
Variables
{"id": 4, "idType": "DATABASE_ID"}
Response
{
"data": {
"user": {
"avatar": Avatar,
"capKey": "xyz789",
"capabilities": ["abc123"],
"comments": UserToCommentConnection,
"databaseId": 123,
"description": "xyz789",
"email": "xyz789",
"enqueuedScripts": UserToEnqueuedScriptConnection,
"enqueuedStylesheets": UserToEnqueuedStylesheetConnection,
"extraCapabilities": ["abc123"],
"firstName": "abc123",
"id": "4",
"isComment": true,
"isContentNode": false,
"isFrontPage": false,
"isPostsPage": false,
"isRestricted": false,
"isTermNode": true,
"lastName": "abc123",
"locale": "xyz789",
"mediaItems": UserToMediaItemConnection,
"name": "xyz789",
"nicename": "xyz789",
"nickname": "xyz789",
"pages": UserToPageConnection,
"posts": UserToPostConnection,
"registeredDate": "xyz789",
"revisions": UserToRevisionsConnection,
"roles": UserToUserRoleConnection,
"shouldShowAdminToolbar": true,
"slug": "xyz789",
"uri": "abc123",
"url": "abc123",
"userId": 123,
"username": "abc123"
}
}
}
userRole
Description
Returns a user role
Response
Returns a UserRole
Arguments
| Name | Description |
|---|---|
id - ID!
|
The globally unique identifier of the user object. |
Example
Query
query userRole($id: ID!) {
userRole(id: $id) {
capabilities
displayName
id
isRestricted
name
}
}
Variables
{"id": "4"}
Response
{
"data": {
"userRole": {
"capabilities": ["xyz789"],
"displayName": "abc123",
"id": 4,
"isRestricted": false,
"name": "abc123"
}
}
}
userRoles
Description
Connection between the RootQuery type and the UserRole type
Response
Returns a RootQueryToUserRoleConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
The number of items to return after the referenced "after" cursor |
last - Int
|
The number of items to return before the referenced "before" cursor |
after - String
|
Cursor used along with the "first" argument to reference where in the dataset to get data |
before - String
|
Cursor used along with the "last" argument to reference where in the dataset to get data |
Example
Query
query userRoles(
$first: Int,
$last: Int,
$after: String,
$before: String
) {
userRoles(
first: $first,
last: $last,
after: $after,
before: $before
) {
edges {
...RootQueryToUserRoleConnectionEdgeFragment
}
nodes {
...UserRoleFragment
}
pageInfo {
...RootQueryToUserRoleConnectionPageInfoFragment
}
}
}
Variables
{
"first": 123,
"last": 123,
"after": "abc123",
"before": "xyz789"
}
Response
{
"data": {
"userRoles": {
"edges": [RootQueryToUserRoleConnectionEdge],
"nodes": [UserRole],
"pageInfo": RootQueryToUserRoleConnectionPageInfo
}
}
}
users
Description
Connection between the RootQuery type and the User type
Response
Returns a RootQueryToUserConnection
Arguments
| Name | Description |
|---|---|
first - Int
|
The number of items to return after the referenced "after" cursor |
last - Int
|
The number of items to return before the referenced "before" cursor |
after - String
|
Cursor used along with the "first" argument to reference where in the dataset to get data |
before - String
|
Cursor used along with the "last" argument to reference where in the dataset to get data |
where - RootQueryToUserConnectionWhereArgs
|
Arguments for filtering the connection |
Example
Query
query users(
$first: Int,
$last: Int,
$after: String,
$before: String,
$where: RootQueryToUserConnectionWhereArgs
) {
users(
first: $first,
last: $last,
after: $after,
before: $before,
where: $where
) {
edges {
...RootQueryToUserConnectionEdgeFragment
}
nodes {
...UserFragment
}
pageInfo {
...RootQueryToUserConnectionPageInfoFragment
}
}
}
Variables
{
"first": 987,
"last": 987,
"after": "abc123",
"before": "abc123",
"where": RootQueryToUserConnectionWhereArgs
}
Response
{
"data": {
"users": {
"edges": [RootQueryToUserConnectionEdge],
"nodes": [User],
"pageInfo": RootQueryToUserConnectionPageInfo
}
}
}
viewer
Description
Returns the current user
Response
Returns a User
Example
Query
query viewer {
viewer {
avatar {
...AvatarFragment
}
capKey
capabilities
comments {
...UserToCommentConnectionFragment
}
databaseId
description
email
enqueuedScripts {
...UserToEnqueuedScriptConnectionFragment
}
enqueuedStylesheets {
...UserToEnqueuedStylesheetConnectionFragment
}
extraCapabilities
firstName
id
isComment
isContentNode
isFrontPage
isPostsPage
isRestricted
isTermNode
lastName
locale
mediaItems {
...UserToMediaItemConnectionFragment
}
name
nicename
nickname
pages {
...UserToPageConnectionFragment
}
posts {
...UserToPostConnectionFragment
}
registeredDate
revisions {
...UserToRevisionsConnectionFragment
}
roles {
...UserToUserRoleConnectionFragment
}
shouldShowAdminToolbar
slug
uri
url
userId
username
}
}
Response
{
"data": {
"viewer": {
"avatar": Avatar,
"capKey": "xyz789",
"capabilities": ["xyz789"],
"comments": UserToCommentConnection,
"databaseId": 123,
"description": "xyz789",
"email": "xyz789",
"enqueuedScripts": UserToEnqueuedScriptConnection,
"enqueuedStylesheets": UserToEnqueuedStylesheetConnection,
"extraCapabilities": ["xyz789"],
"firstName": "xyz789",
"id": 4,
"isComment": false,
"isContentNode": false,
"isFrontPage": true,
"isPostsPage": true,
"isRestricted": true,
"isTermNode": false,
"lastName": "abc123",
"locale": "xyz789",
"mediaItems": UserToMediaItemConnection,
"name": "abc123",
"nicename": "abc123",
"nickname": "abc123",
"pages": UserToPageConnection,
"posts": UserToPostConnection,
"registeredDate": "abc123",
"revisions": UserToRevisionsConnection,
"roles": UserToUserRoleConnection,
"shouldShowAdminToolbar": true,
"slug": "xyz789",
"uri": "xyz789",
"url": "abc123",
"userId": 987,
"username": "abc123"
}
}
}
writingSettings
Description
Fields of the 'WritingSettings' settings group
Response
Returns a WritingSettings
Example
Query
query writingSettings {
writingSettings {
defaultCategory
defaultPostFormat
useSmilies
}
}
Response
{
"data": {
"writingSettings": {
"defaultCategory": 123,
"defaultPostFormat": "xyz789",
"useSmilies": false
}
}
}
Mutations
createCategory
Description
The createCategory mutation
Response
Returns a CreateCategoryPayload
Arguments
| Name | Description |
|---|---|
input - CreateCategoryInput!
|
Input for the createCategory mutation |
Example
Query
mutation createCategory($input: CreateCategoryInput!) {
createCategory(input: $input) {
category {
...CategoryFragment
}
clientMutationId
}
}
Variables
{"input": CreateCategoryInput}
Response
{
"data": {
"createCategory": {
"category": Category,
"clientMutationId": "abc123"
}
}
}
createCollection
Description
The createCollection mutation
Response
Returns a CreateCollectionPayload
Arguments
| Name | Description |
|---|---|
input - CreateCollectionInput!
|
Input for the createCollection mutation |
Example
Query
mutation createCollection($input: CreateCollectionInput!) {
createCollection(input: $input) {
clientMutationId
collection {
...CollectionFragment
}
}
}
Variables
{"input": CreateCollectionInput}
Response
{
"data": {
"createCollection": {
"clientMutationId": "xyz789",
"collection": Collection
}
}
}
createComment
Description
The createComment mutation
Response
Returns a CreateCommentPayload
Arguments
| Name | Description |
|---|---|
input - CreateCommentInput!
|
Input for the createComment mutation |
Example
Query
mutation createComment($input: CreateCommentInput!) {
createComment(input: $input) {
clientMutationId
comment {
...CommentFragment
}
success
}
}
Variables
{"input": CreateCommentInput}
Response
{
"data": {
"createComment": {
"clientMutationId": "abc123",
"comment": Comment,
"success": false
}
}
}
createContact
Description
The createContact mutation
Response
Returns a CreateContactPayload
Arguments
| Name | Description |
|---|---|
input - CreateContactInput!
|
Input for the createContact mutation |
Example
Query
mutation createContact($input: CreateContactInput!) {
createContact(input: $input) {
clientMutationId
contact {
...ContactFragment
}
}
}
Variables
{"input": CreateContactInput}
Response
{
"data": {
"createContact": {
"clientMutationId": "xyz789",
"contact": Contact
}
}
}
createLandingPage
Description
The createLandingPage mutation
Response
Returns a CreateLandingPagePayload
Arguments
| Name | Description |
|---|---|
input - CreateLandingPageInput!
|
Input for the createLandingPage mutation |
Example
Query
mutation createLandingPage($input: CreateLandingPageInput!) {
createLandingPage(input: $input) {
clientMutationId
landingPage {
...LandingPageFragment
}
}
}
Variables
{"input": CreateLandingPageInput}
Response
{
"data": {
"createLandingPage": {
"clientMutationId": "xyz789",
"landingPage": LandingPage
}
}
}
createMediaItem
Description
The createMediaItem mutation
Response
Returns a CreateMediaItemPayload
Arguments
| Name | Description |
|---|---|
input - CreateMediaItemInput!
|
Input for the createMediaItem mutation |
Example
Query
mutation createMediaItem($input: CreateMediaItemInput!) {
createMediaItem(input: $input) {
clientMutationId
mediaItem {
...MediaItemFragment
}
}
}
Variables
{"input": CreateMediaItemInput}
Response
{
"data": {
"createMediaItem": {
"clientMutationId": "abc123",
"mediaItem": MediaItem
}
}
}
createPage
Description
The createPage mutation
Response
Returns a CreatePagePayload
Arguments
| Name | Description |
|---|---|
input - CreatePageInput!
|
Input for the createPage mutation |
Example
Query
mutation createPage($input: CreatePageInput!) {
createPage(input: $input) {
clientMutationId
page {
...PageFragment
}
}
}
Variables
{"input": CreatePageInput}
Response
{
"data": {
"createPage": {
"clientMutationId": "xyz789",
"page": Page
}
}
}
createPost
Description
The createPost mutation
Response
Returns a CreatePostPayload
Arguments
| Name | Description |
|---|---|
input - CreatePostInput!
|
Input for the createPost mutation |
Example
Query
mutation createPost($input: CreatePostInput!) {
createPost(input: $input) {
clientMutationId
post {
...PostFragment
}
}
}
Variables
{"input": CreatePostInput}
Response
{
"data": {
"createPost": {
"clientMutationId": "abc123",
"post": Post
}
}
}
createPostFormat
Description
The createPostFormat mutation
Response
Returns a CreatePostFormatPayload
Arguments
| Name | Description |
|---|---|
input - CreatePostFormatInput!
|
Input for the createPostFormat mutation |
Example
Query
mutation createPostFormat($input: CreatePostFormatInput!) {
createPostFormat(input: $input) {
clientMutationId
postFormat {
...PostFormatFragment
}
}
}
Variables
{"input": CreatePostFormatInput}
Response
{
"data": {
"createPostFormat": {
"clientMutationId": "xyz789",
"postFormat": PostFormat
}
}
}
createRelease
Description
The createRelease mutation
Response
Returns a CreateReleasePayload
Arguments
| Name | Description |
|---|---|
input - CreateReleaseInput!
|
Input for the createRelease mutation |
Example
Query
mutation createRelease($input: CreateReleaseInput!) {
createRelease(input: $input) {
clientMutationId
release {
...ReleaseFragment
}
}
}
Variables
{"input": CreateReleaseInput}
Response
{
"data": {
"createRelease": {
"clientMutationId": "abc123",
"release": Release
}
}
}
createTag
Description
The createTag mutation
Response
Returns a CreateTagPayload
Arguments
| Name | Description |
|---|---|
input - CreateTagInput!
|
Input for the createTag mutation |
Example
Query
mutation createTag($input: CreateTagInput!) {
createTag(input: $input) {
clientMutationId
tag {
...TagFragment
}
}
}
Variables
{"input": CreateTagInput}
Response
{
"data": {
"createTag": {
"clientMutationId": "abc123",
"tag": Tag
}
}
}
createTranslation
Description
The createTranslation mutation
Response
Returns a CreateTranslationPayload
Arguments
| Name | Description |
|---|---|
input - CreateTranslationInput!
|
Input for the createTranslation mutation |
Example
Query
mutation createTranslation($input: CreateTranslationInput!) {
createTranslation(input: $input) {
clientMutationId
translation {
...TranslationFragment
}
}
}
Variables
{"input": CreateTranslationInput}
Response
{
"data": {
"createTranslation": {
"clientMutationId": "abc123",
"translation": Translation
}
}
}
createUser
Description
The createUser mutation
Response
Returns a CreateUserPayload
Arguments
| Name | Description |
|---|---|
input - CreateUserInput!
|
Input for the createUser mutation |
Example
Query
mutation createUser($input: CreateUserInput!) {
createUser(input: $input) {
clientMutationId
user {
...UserFragment
}
}
}
Variables
{"input": CreateUserInput}
Response
{
"data": {
"createUser": {
"clientMutationId": "xyz789",
"user": User
}
}
}
deleteCategory
Description
The deleteCategory mutation
Response
Returns a DeleteCategoryPayload
Arguments
| Name | Description |
|---|---|
input - DeleteCategoryInput!
|
Input for the deleteCategory mutation |
Example
Query
mutation deleteCategory($input: DeleteCategoryInput!) {
deleteCategory(input: $input) {
category {
...CategoryFragment
}
clientMutationId
deletedId
}
}
Variables
{"input": DeleteCategoryInput}
Response
{
"data": {
"deleteCategory": {
"category": Category,
"clientMutationId": "xyz789",
"deletedId": "4"
}
}
}
deleteCollection
Description
The deleteCollection mutation
Response
Returns a DeleteCollectionPayload
Arguments
| Name | Description |
|---|---|
input - DeleteCollectionInput!
|
Input for the deleteCollection mutation |
Example
Query
mutation deleteCollection($input: DeleteCollectionInput!) {
deleteCollection(input: $input) {
clientMutationId
collection {
...CollectionFragment
}
deletedId
}
}
Variables
{"input": DeleteCollectionInput}
Response
{
"data": {
"deleteCollection": {
"clientMutationId": "xyz789",
"collection": Collection,
"deletedId": 4
}
}
}
deleteComment
Description
The deleteComment mutation
Response
Returns a DeleteCommentPayload
Arguments
| Name | Description |
|---|---|
input - DeleteCommentInput!
|
Input for the deleteComment mutation |
Example
Query
mutation deleteComment($input: DeleteCommentInput!) {
deleteComment(input: $input) {
clientMutationId
comment {
...CommentFragment
}
deletedId
}
}
Variables
{"input": DeleteCommentInput}
Response
{
"data": {
"deleteComment": {
"clientMutationId": "abc123",
"comment": Comment,
"deletedId": "4"
}
}
}
deleteContact
Description
The deleteContact mutation
Response
Returns a DeleteContactPayload
Arguments
| Name | Description |
|---|---|
input - DeleteContactInput!
|
Input for the deleteContact mutation |
Example
Query
mutation deleteContact($input: DeleteContactInput!) {
deleteContact(input: $input) {
clientMutationId
contact {
...ContactFragment
}
deletedId
}
}
Variables
{"input": DeleteContactInput}
Response
{
"data": {
"deleteContact": {
"clientMutationId": "abc123",
"contact": Contact,
"deletedId": 4
}
}
}
deleteLandingPage
Description
The deleteLandingPage mutation
Response
Returns a DeleteLandingPagePayload
Arguments
| Name | Description |
|---|---|
input - DeleteLandingPageInput!
|
Input for the deleteLandingPage mutation |
Example
Query
mutation deleteLandingPage($input: DeleteLandingPageInput!) {
deleteLandingPage(input: $input) {
clientMutationId
deletedId
landingPage {
...LandingPageFragment
}
}
}
Variables
{"input": DeleteLandingPageInput}
Response
{
"data": {
"deleteLandingPage": {
"clientMutationId": "abc123",
"deletedId": "4",
"landingPage": LandingPage
}
}
}
deleteMediaItem
Description
The deleteMediaItem mutation
Response
Returns a DeleteMediaItemPayload
Arguments
| Name | Description |
|---|---|
input - DeleteMediaItemInput!
|
Input for the deleteMediaItem mutation |
Example
Query
mutation deleteMediaItem($input: DeleteMediaItemInput!) {
deleteMediaItem(input: $input) {
clientMutationId
deletedId
mediaItem {
...MediaItemFragment
}
}
}
Variables
{"input": DeleteMediaItemInput}
Response
{
"data": {
"deleteMediaItem": {
"clientMutationId": "abc123",
"deletedId": 4,
"mediaItem": MediaItem
}
}
}
deletePage
Description
The deletePage mutation
Response
Returns a DeletePagePayload
Arguments
| Name | Description |
|---|---|
input - DeletePageInput!
|
Input for the deletePage mutation |
Example
Query
mutation deletePage($input: DeletePageInput!) {
deletePage(input: $input) {
clientMutationId
deletedId
page {
...PageFragment
}
}
}
Variables
{"input": DeletePageInput}
Response
{
"data": {
"deletePage": {
"clientMutationId": "xyz789",
"deletedId": "4",
"page": Page
}
}
}
deletePost
Description
The deletePost mutation
Response
Returns a DeletePostPayload
Arguments
| Name | Description |
|---|---|
input - DeletePostInput!
|
Input for the deletePost mutation |
Example
Query
mutation deletePost($input: DeletePostInput!) {
deletePost(input: $input) {
clientMutationId
deletedId
post {
...PostFragment
}
}
}
Variables
{"input": DeletePostInput}
Response
{
"data": {
"deletePost": {
"clientMutationId": "xyz789",
"deletedId": "4",
"post": Post
}
}
}
deletePostFormat
Description
The deletePostFormat mutation
Response
Returns a DeletePostFormatPayload
Arguments
| Name | Description |
|---|---|
input - DeletePostFormatInput!
|
Input for the deletePostFormat mutation |
Example
Query
mutation deletePostFormat($input: DeletePostFormatInput!) {
deletePostFormat(input: $input) {
clientMutationId
deletedId
postFormat {
...PostFormatFragment
}
}
}
Variables
{"input": DeletePostFormatInput}
Response
{
"data": {
"deletePostFormat": {
"clientMutationId": "xyz789",
"deletedId": 4,
"postFormat": PostFormat
}
}
}
deleteRelease
Description
The deleteRelease mutation
Response
Returns a DeleteReleasePayload
Arguments
| Name | Description |
|---|---|
input - DeleteReleaseInput!
|
Input for the deleteRelease mutation |
Example
Query
mutation deleteRelease($input: DeleteReleaseInput!) {
deleteRelease(input: $input) {
clientMutationId
deletedId
release {
...ReleaseFragment
}
}
}
Variables
{"input": DeleteReleaseInput}
Response
{
"data": {
"deleteRelease": {
"clientMutationId": "xyz789",
"deletedId": 4,
"release": Release
}
}
}
deleteTag
Description
The deleteTag mutation
Response
Returns a DeleteTagPayload
Arguments
| Name | Description |
|---|---|
input - DeleteTagInput!
|
Input for the deleteTag mutation |
Example
Query
mutation deleteTag($input: DeleteTagInput!) {
deleteTag(input: $input) {
clientMutationId
deletedId
tag {
...TagFragment
}
}
}
Variables
{"input": DeleteTagInput}
Response
{
"data": {
"deleteTag": {
"clientMutationId": "xyz789",
"deletedId": 4,
"tag": Tag
}
}
}
deleteTranslation
Description
The deleteTranslation mutation
Response
Returns a DeleteTranslationPayload
Arguments
| Name | Description |
|---|---|
input - DeleteTranslationInput!
|
Input for the deleteTranslation mutation |
Example
Query
mutation deleteTranslation($input: DeleteTranslationInput!) {
deleteTranslation(input: $input) {
clientMutationId
deletedId
translation {
...TranslationFragment
}
}
}
Variables
{"input": DeleteTranslationInput}
Response
{
"data": {
"deleteTranslation": {
"clientMutationId": "abc123",
"deletedId": 4,
"translation": Translation
}
}
}
deleteUser
Description
The deleteUser mutation
Response
Returns a DeleteUserPayload
Arguments
| Name | Description |
|---|---|
input - DeleteUserInput!
|
Input for the deleteUser mutation |
Example
Query
mutation deleteUser($input: DeleteUserInput!) {
deleteUser(input: $input) {
clientMutationId
deletedId
user {
...UserFragment
}
}
}
Variables
{"input": DeleteUserInput}
Response
{
"data": {
"deleteUser": {
"clientMutationId": "abc123",
"deletedId": 4,
"user": User
}
}
}
increaseCount
Description
Increase the count.
registerUser
Description
The registerUser mutation
Response
Returns a RegisterUserPayload
Arguments
| Name | Description |
|---|---|
input - RegisterUserInput!
|
Input for the registerUser mutation |
Example
Query
mutation registerUser($input: RegisterUserInput!) {
registerUser(input: $input) {
clientMutationId
user {
...UserFragment
}
}
}
Variables
{"input": RegisterUserInput}
Response
{
"data": {
"registerUser": {
"clientMutationId": "xyz789",
"user": User
}
}
}
resetUserPassword
Description
The resetUserPassword mutation
Response
Returns a ResetUserPasswordPayload
Arguments
| Name | Description |
|---|---|
input - ResetUserPasswordInput!
|
Input for the resetUserPassword mutation |
Example
Query
mutation resetUserPassword($input: ResetUserPasswordInput!) {
resetUserPassword(input: $input) {
clientMutationId
user {
...UserFragment
}
}
}
Variables
{"input": ResetUserPasswordInput}
Response
{
"data": {
"resetUserPassword": {
"clientMutationId": "xyz789",
"user": User
}
}
}
restoreComment
Description
The restoreComment mutation
Response
Returns a RestoreCommentPayload
Arguments
| Name | Description |
|---|---|
input - RestoreCommentInput!
|
Input for the restoreComment mutation |
Example
Query
mutation restoreComment($input: RestoreCommentInput!) {
restoreComment(input: $input) {
clientMutationId
comment {
...CommentFragment
}
restoredId
}
}
Variables
{"input": RestoreCommentInput}
Response
{
"data": {
"restoreComment": {
"clientMutationId": "abc123",
"comment": Comment,
"restoredId": "4"
}
}
}
sendPasswordResetEmail
Description
Send password reset email to user
Response
Returns a SendPasswordResetEmailPayload
Arguments
| Name | Description |
|---|---|
input - SendPasswordResetEmailInput!
|
Input for the sendPasswordResetEmail mutation |
Example
Query
mutation sendPasswordResetEmail($input: SendPasswordResetEmailInput!) {
sendPasswordResetEmail(input: $input) {
clientMutationId
success
user {
...UserFragment
}
}
}
Variables
{"input": SendPasswordResetEmailInput}
Response
{
"data": {
"sendPasswordResetEmail": {
"clientMutationId": "abc123",
"success": false,
"user": User
}
}
}
updateCategory
Description
The updateCategory mutation
Response
Returns an UpdateCategoryPayload
Arguments
| Name | Description |
|---|---|
input - UpdateCategoryInput!
|
Input for the updateCategory mutation |
Example
Query
mutation updateCategory($input: UpdateCategoryInput!) {
updateCategory(input: $input) {
category {
...CategoryFragment
}
clientMutationId
}
}
Variables
{"input": UpdateCategoryInput}
Response
{
"data": {
"updateCategory": {
"category": Category,
"clientMutationId": "abc123"
}
}
}
updateCollection
Description
The updateCollection mutation
Response
Returns an UpdateCollectionPayload
Arguments
| Name | Description |
|---|---|
input - UpdateCollectionInput!
|
Input for the updateCollection mutation |
Example
Query
mutation updateCollection($input: UpdateCollectionInput!) {
updateCollection(input: $input) {
clientMutationId
collection {
...CollectionFragment
}
}
}
Variables
{"input": UpdateCollectionInput}
Response
{
"data": {
"updateCollection": {
"clientMutationId": "abc123",
"collection": Collection
}
}
}
updateComment
Description
The updateComment mutation
Response
Returns an UpdateCommentPayload
Arguments
| Name | Description |
|---|---|
input - UpdateCommentInput!
|
Input for the updateComment mutation |
Example
Query
mutation updateComment($input: UpdateCommentInput!) {
updateComment(input: $input) {
clientMutationId
comment {
...CommentFragment
}
success
}
}
Variables
{"input": UpdateCommentInput}
Response
{
"data": {
"updateComment": {
"clientMutationId": "xyz789",
"comment": Comment,
"success": true
}
}
}
updateContact
Description
The updateContact mutation
Response
Returns an UpdateContactPayload
Arguments
| Name | Description |
|---|---|
input - UpdateContactInput!
|
Input for the updateContact mutation |
Example
Query
mutation updateContact($input: UpdateContactInput!) {
updateContact(input: $input) {
clientMutationId
contact {
...ContactFragment
}
}
}
Variables
{"input": UpdateContactInput}
Response
{
"data": {
"updateContact": {
"clientMutationId": "xyz789",
"contact": Contact
}
}
}
updateLandingPage
Description
The updateLandingPage mutation
Response
Returns an UpdateLandingPagePayload
Arguments
| Name | Description |
|---|---|
input - UpdateLandingPageInput!
|
Input for the updateLandingPage mutation |
Example
Query
mutation updateLandingPage($input: UpdateLandingPageInput!) {
updateLandingPage(input: $input) {
clientMutationId
landingPage {
...LandingPageFragment
}
}
}
Variables
{"input": UpdateLandingPageInput}
Response
{
"data": {
"updateLandingPage": {
"clientMutationId": "xyz789",
"landingPage": LandingPage
}
}
}
updateMediaItem
Description
The updateMediaItem mutation
Response
Returns an UpdateMediaItemPayload
Arguments
| Name | Description |
|---|---|
input - UpdateMediaItemInput!
|
Input for the updateMediaItem mutation |
Example
Query
mutation updateMediaItem($input: UpdateMediaItemInput!) {
updateMediaItem(input: $input) {
clientMutationId
mediaItem {
...MediaItemFragment
}
}
}
Variables
{"input": UpdateMediaItemInput}
Response
{
"data": {
"updateMediaItem": {
"clientMutationId": "xyz789",
"mediaItem": MediaItem
}
}
}
updatePage
Description
The updatePage mutation
Response
Returns an UpdatePagePayload
Arguments
| Name | Description |
|---|---|
input - UpdatePageInput!
|
Input for the updatePage mutation |
Example
Query
mutation updatePage($input: UpdatePageInput!) {
updatePage(input: $input) {
clientMutationId
page {
...PageFragment
}
}
}
Variables
{"input": UpdatePageInput}
Response
{
"data": {
"updatePage": {
"clientMutationId": "abc123",
"page": Page
}
}
}
updatePost
Description
The updatePost mutation
Response
Returns an UpdatePostPayload
Arguments
| Name | Description |
|---|---|
input - UpdatePostInput!
|
Input for the updatePost mutation |
Example
Query
mutation updatePost($input: UpdatePostInput!) {
updatePost(input: $input) {
clientMutationId
post {
...PostFragment
}
}
}
Variables
{"input": UpdatePostInput}
Response
{
"data": {
"updatePost": {
"clientMutationId": "abc123",
"post": Post
}
}
}
updatePostFormat
Description
The updatePostFormat mutation
Response
Returns an UpdatePostFormatPayload
Arguments
| Name | Description |
|---|---|
input - UpdatePostFormatInput!
|
Input for the updatePostFormat mutation |
Example
Query
mutation updatePostFormat($input: UpdatePostFormatInput!) {
updatePostFormat(input: $input) {
clientMutationId
postFormat {
...PostFormatFragment
}
}
}
Variables
{"input": UpdatePostFormatInput}
Response
{
"data": {
"updatePostFormat": {
"clientMutationId": "xyz789",
"postFormat": PostFormat
}
}
}
updateRelease
Description
The updateRelease mutation
Response
Returns an UpdateReleasePayload
Arguments
| Name | Description |
|---|---|
input - UpdateReleaseInput!
|
Input for the updateRelease mutation |
Example
Query
mutation updateRelease($input: UpdateReleaseInput!) {
updateRelease(input: $input) {
clientMutationId
release {
...ReleaseFragment
}
}
}
Variables
{"input": UpdateReleaseInput}
Response
{
"data": {
"updateRelease": {
"clientMutationId": "xyz789",
"release": Release
}
}
}
updateSettings
Description
The updateSettings mutation
Response
Returns an UpdateSettingsPayload
Arguments
| Name | Description |
|---|---|
input - UpdateSettingsInput!
|
Input for the updateSettings mutation |
Example
Query
mutation updateSettings($input: UpdateSettingsInput!) {
updateSettings(input: $input) {
allSettings {
...SettingsFragment
}
clientMutationId
discussionSettings {
...DiscussionSettingsFragment
}
generalSettings {
...GeneralSettingsFragment
}
readingSettings {
...ReadingSettingsFragment
}
writingSettings {
...WritingSettingsFragment
}
}
}
Variables
{"input": UpdateSettingsInput}
Response
{
"data": {
"updateSettings": {
"allSettings": Settings,
"clientMutationId": "xyz789",
"discussionSettings": DiscussionSettings,
"generalSettings": GeneralSettings,
"readingSettings": ReadingSettings,
"writingSettings": WritingSettings
}
}
}
updateTag
Description
The updateTag mutation
Response
Returns an UpdateTagPayload
Arguments
| Name | Description |
|---|---|
input - UpdateTagInput!
|
Input for the updateTag mutation |
Example
Query
mutation updateTag($input: UpdateTagInput!) {
updateTag(input: $input) {
clientMutationId
tag {
...TagFragment
}
}
}
Variables
{"input": UpdateTagInput}
Response
{
"data": {
"updateTag": {
"clientMutationId": "abc123",
"tag": Tag
}
}
}
updateTranslation
Description
The updateTranslation mutation
Response
Returns an UpdateTranslationPayload
Arguments
| Name | Description |
|---|---|
input - UpdateTranslationInput!
|
Input for the updateTranslation mutation |
Example
Query
mutation updateTranslation($input: UpdateTranslationInput!) {
updateTranslation(input: $input) {
clientMutationId
translation {
...TranslationFragment
}
}
}
Variables
{"input": UpdateTranslationInput}
Response
{
"data": {
"updateTranslation": {
"clientMutationId": "abc123",
"translation": Translation
}
}
}
updateUser
Description
The updateUser mutation
Response
Returns an UpdateUserPayload
Arguments
| Name | Description |
|---|---|
input - UpdateUserInput!
|
Input for the updateUser mutation |
Example
Query
mutation updateUser($input: UpdateUserInput!) {
updateUser(input: $input) {
clientMutationId
user {
...UserFragment
}
}
}
Variables
{"input": UpdateUserInput}
Response
{
"data": {
"updateUser": {
"clientMutationId": "abc123",
"user": User
}
}
}
Types
Avatar
Description
Avatars are profile images for users. WordPress by default uses the Gravatar service to host and fetch avatars from.
Fields
| Field Name | Description |
|---|---|
default - String
|
URL for the default image or a default type. Accepts '404' (return a 404 instead of a default image), 'retro' (8bit), 'monsterid' (monster), 'wavatar' (cartoon face), 'indenticon' (the 'quilt'), 'mystery', 'mm', or 'mysteryman' (The Oyster Man), 'blank' (transparent GIF), or 'gravatar_default' (the Gravatar logo). |
extraAttr - String
|
HTML attributes to insert in the IMG element. Is not sanitized. |
forceDefault - Boolean
|
Whether to always show the default image, never the Gravatar. |
foundAvatar - Boolean
|
Whether the avatar was successfully found. |
height - Int
|
Height of the avatar image. |
isRestricted - Boolean
|
Whether the object is restricted from the current viewer |
rating - String
|
What rating to display avatars up to. Accepts 'G', 'PG', 'R', 'X', and are judged in that order. |
scheme - String
|
Type of url scheme to use. Typically HTTP vs. HTTPS. |
size - Int
|
The size of the avatar in pixels. A value of 96 will match a 96px x 96px gravatar image. |
url - String
|
URL for the gravatar image source. |
width - Int
|
Width of the avatar image. |
Example
{
"default": "abc123",
"extraAttr": "abc123",
"forceDefault": false,
"foundAvatar": false,
"height": 987,
"isRestricted": false,
"rating": "abc123",
"scheme": "abc123",
"size": 123,
"url": "xyz789",
"width": 123
}
AvatarRatingEnum
Description
What rating to display avatars up to. Accepts 'G', 'PG', 'R', 'X', and are judged in that order. Default is the value of the 'avatar_rating' option
Values
| Enum Value | Description |
|---|---|
|
|
Indicates a G level avatar rating level. |
|
|
Indicates a PG level avatar rating level. |
|
|
Indicates an R level avatar rating level. |
|
|
Indicates an X level avatar rating level. |
Example
"G"
Boolean
Description
The Boolean scalar type represents true or false.
Breadcrumb
Card
Description
Card field
Example
{
"backgroundColor": "abc123",
"description": "xyz789",
"icon": "xyz789",
"link": Link,
"title": "abc123"
}
Category
Description
The category type
Fields
| Field Name | Description |
|---|---|
ancestors - CategoryToAncestorsCategoryConnection
|
The ancestors of the node. Default ordered as lowest (closest to the child) to highest (closest to the root). |
Arguments
|
|
categoryId - Int
|
The id field matches the WP_Post->ID field. Deprecated in favor of databaseId |
children - CategoryToCategoryConnection
|
Connection between the category type and its children categories. |
Arguments
|
|
contentNodes - CategoryToContentNodeConnection
|
Connection between the Category type and the ContentNode type |
Arguments
|
|
count - Int
|
The number of objects connected to the object |
databaseId - Int!
|
The unique identifier stored in the database |
description - String
|
The description of the object |
enqueuedScripts - TermNodeToEnqueuedScriptConnection
|
Connection between the TermNode type and the EnqueuedScript type |
Arguments
|
|
enqueuedStylesheets - TermNodeToEnqueuedStylesheetConnection
|
Connection between the TermNode type and the EnqueuedStylesheet type |
Arguments
|
|
id - ID!
|
The globally unique ID for the object |
isComment - Boolean!
|
Whether the node is a Comment |
isContentNode - Boolean!
|
Whether the node is a Content Node |
isFrontPage - Boolean!
|
Whether the node represents the front page. |
isPostsPage - Boolean!
|
Whether the node represents the blog page. |
isRestricted - Boolean
|
Whether the object is restricted from the current viewer |
isTermNode - Boolean!
|
Whether the node is a Term |
language - Language
|
List available translations for this post |
link - String
|
The link to the term |
name - String
|
The human friendly name of the object. |
parent - CategoryToParentCategoryConnectionEdge
|
Connection between the category type and its parent category. |
parentDatabaseId - Int
|
Database id of the parent node |
parentId - ID
|
The globally unique identifier of the parent node. |
posts - CategoryToPostConnection
|
Connection between the Category type and the post type |
Arguments
|
|
slug - String
|
An alphanumeric identifier for the object unique to its type. |
taxonomy - CategoryToTaxonomyConnectionEdge
|
Connection between the Category type and the Taxonomy type |
taxonomyName - String
|
The name of the taxonomy that the object is associated with |
termGroupId - Int
|
The ID of the term group that this term object belongs to |
termTaxonomyId - Int
|
The taxonomy ID that the object is associated with |
translation - Category
|
Get specific translation version of this object |
Arguments
|
|
translations - [Category]
|
List all translated versions of this term |
uri - String
|
The unique resource identifier path |
Example
{
"ancestors": CategoryToAncestorsCategoryConnection,
"categoryId": 123,
"children": CategoryToCategoryConnection,
"contentNodes": CategoryToContentNodeConnection,
"count": 123,
"databaseId": 123,
"description": "xyz789",
"enqueuedScripts": TermNodeToEnqueuedScriptConnection,
"enqueuedStylesheets": TermNodeToEnqueuedStylesheetConnection,
"id": 4,
"isComment": true,
"isContentNode": false,
"isFrontPage": true,
"isPostsPage": false,
"isRestricted": false,
"isTermNode": false,
"language": Language,
"link": "abc123",
"name": "abc123",
"parent": CategoryToParentCategoryConnectionEdge,
"parentDatabaseId": 987,
"parentId": "4",
"posts": CategoryToPostConnection,
"slug": "xyz789",
"taxonomy": CategoryToTaxonomyConnectionEdge,
"taxonomyName": "abc123",
"termGroupId": 123,
"termTaxonomyId": 987,
"translation": Category,
"translations": [Category],
"uri": "xyz789"
}
CategoryConnection
Description
Connection to category Nodes
Fields
| Field Name | Description |
|---|---|
edges - [CategoryConnectionEdge!]!
|
A list of edges (relational context) between RootQuery and connected category Nodes |
nodes - [Category!]!
|
A list of connected category Nodes |
pageInfo - CategoryConnectionPageInfo!
|
Information about pagination in a connection. |
Possible Types
| CategoryConnection Types |
|---|
Example
{
"edges": [CategoryConnectionEdge],
"nodes": [Category],
"pageInfo": CategoryConnectionPageInfo
}
CategoryConnectionEdge
Description
Edge between a Node and a connected category
Fields
| Field Name | Description |
|---|---|
cursor - String
|
Opaque reference to the nodes position in the connection. Value can be used with pagination args. |
node - Category!
|
The connected category Node |
Possible Types
| CategoryConnectionEdge Types |
|---|
Example
{
"cursor": "abc123",
"node": Category
}
CategoryConnectionPageInfo
Description
Page Info on the connected CategoryConnectionEdge
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Possible Types
| CategoryConnectionPageInfo Types |
|---|
Example
{
"endCursor": "xyz789",
"hasNextPage": false,
"hasPreviousPage": true,
"startCursor": "xyz789"
}
CategoryIdType
Description
The Type of Identifier used to fetch a single resource. Default is ID.
Values
| Enum Value | Description |
|---|---|
|
|
The Database ID for the node |
|
|
The hashed Global ID |
|
|
The name of the node |
|
|
Url friendly name of the node |
|
|
The URI for the node |
Example
"DATABASE_ID"
CategoryToAncestorsCategoryConnection
Description
Connection between the Category type and the category type
Fields
| Field Name | Description |
|---|---|
edges - [CategoryToAncestorsCategoryConnectionEdge!]!
|
Edges for the CategoryToAncestorsCategoryConnection connection |
nodes - [Category!]!
|
The nodes of the connection, without the edges |
pageInfo - CategoryToAncestorsCategoryConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [CategoryToAncestorsCategoryConnectionEdge],
"nodes": [Category],
"pageInfo": CategoryToAncestorsCategoryConnectionPageInfo
}
CategoryToAncestorsCategoryConnectionEdge
CategoryToAncestorsCategoryConnectionPageInfo
Description
Page Info on the "CategoryToAncestorsCategoryConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "xyz789",
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "xyz789"
}
CategoryToCategoryConnection
Description
Connection between the Category type and the category type
Fields
| Field Name | Description |
|---|---|
edges - [CategoryToCategoryConnectionEdge!]!
|
Edges for the CategoryToCategoryConnection connection |
nodes - [Category!]!
|
The nodes of the connection, without the edges |
pageInfo - CategoryToCategoryConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [CategoryToCategoryConnectionEdge],
"nodes": [Category],
"pageInfo": CategoryToCategoryConnectionPageInfo
}
CategoryToCategoryConnectionEdge
CategoryToCategoryConnectionPageInfo
Description
Page Info on the "CategoryToCategoryConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "xyz789",
"hasNextPage": false,
"hasPreviousPage": true,
"startCursor": "xyz789"
}
CategoryToCategoryConnectionWhereArgs
Description
Arguments for filtering the CategoryToCategoryConnection connection
Fields
| Input Field | Description |
|---|---|
cacheDomain - String
|
Unique cache key to be produced when this query is stored in an object cache. Default is 'core'. |
childOf - Int
|
Term ID to retrieve child terms of. If multiple taxonomies are passed, $child_of is ignored. Default 0. |
childless - Boolean
|
True to limit results to terms that have no children. This parameter has no effect on non-hierarchical taxonomies. Default false. |
descriptionLike - String
|
Retrieve terms where the description is LIKE the input value. Default empty. |
exclude - [ID]
|
Array of term ids to exclude. If $include is non-empty, $exclude is ignored. Default empty array. |
excludeTree - [ID]
|
Array of term ids to exclude along with all of their descendant terms. If $include is non-empty, $exclude_tree is ignored. Default empty array. |
hideEmpty - Boolean
|
Whether to hide terms not assigned to any posts. Accepts true or false. Default false |
hierarchical - Boolean
|
Whether to include terms that have non-empty descendants (even if $hide_empty is set to true). Default true. |
include - [ID]
|
Array of term ids to include. Default empty array. |
name - [String]
|
Array of names to return term(s) for. Default empty. |
nameLike - String
|
Retrieve terms where the name is LIKE the input value. Default empty. |
objectIds - [ID]
|
Array of object IDs. Results will be limited to terms associated with these objects. |
order - OrderEnum
|
Direction the connection should be ordered in |
orderby - TermObjectsConnectionOrderbyEnum
|
Field(s) to order terms by. Defaults to 'name'. |
padCounts - Boolean
|
Whether to pad the quantity of a term's children in the quantity of each term's "count" object variable. Default false. |
parent - Int
|
Parent term ID to retrieve direct-child terms of. Default empty. |
search - String
|
Search criteria to match terms. Will be SQL-formatted with wildcards before and after. Default empty. |
slug - [String]
|
Array of slugs to return term(s) for. Default empty. |
termTaxonomId - [ID]
|
Array of term taxonomy IDs, to match when querying terms. |
termTaxonomyId - [ID]
|
Array of term taxonomy IDs, to match when querying terms. |
updateTermMetaCache - Boolean
|
Whether to prime meta caches for matched terms. Default true. |
Example
{
"cacheDomain": "abc123",
"childOf": 987,
"childless": true,
"descriptionLike": "abc123",
"exclude": ["4"],
"excludeTree": ["4"],
"hideEmpty": false,
"hierarchical": false,
"include": ["4"],
"name": ["xyz789"],
"nameLike": "xyz789",
"objectIds": [4],
"order": "ASC",
"orderby": "COUNT",
"padCounts": true,
"parent": 987,
"search": "xyz789",
"slug": ["xyz789"],
"termTaxonomId": [4],
"termTaxonomyId": ["4"],
"updateTermMetaCache": true
}
CategoryToContentNodeConnection
Description
Connection between the Category type and the ContentNode type
Fields
| Field Name | Description |
|---|---|
edges - [CategoryToContentNodeConnectionEdge!]!
|
Edges for the CategoryToContentNodeConnection connection |
nodes - [ContentNode!]!
|
The nodes of the connection, without the edges |
pageInfo - CategoryToContentNodeConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [CategoryToContentNodeConnectionEdge],
"nodes": [ContentNode],
"pageInfo": CategoryToContentNodeConnectionPageInfo
}
CategoryToContentNodeConnectionEdge
Description
An edge in a connection
Fields
| Field Name | Description |
|---|---|
cursor - String
|
A cursor for use in pagination |
node - ContentNode!
|
The item at the end of the edge |
Example
{
"cursor": "abc123",
"node": ContentNode
}
CategoryToContentNodeConnectionPageInfo
Description
Page Info on the "CategoryToContentNodeConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "xyz789",
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "xyz789"
}
CategoryToContentNodeConnectionWhereArgs
Description
Arguments for filtering the CategoryToContentNodeConnection connection
Fields
| Input Field | Description |
|---|---|
contentTypes - [ContentTypesOfCategoryEnum]
|
The Types of content to filter |
dateQuery - DateQueryInput
|
Filter the connection based on dates |
hasPassword - Boolean
|
True for objects with passwords; False for objects without passwords; null for all objects with or without passwords |
id - Int
|
Specific database ID of the object |
in - [ID]
|
Array of IDs for the objects to retrieve |
mimeType - MimeTypeEnum
|
Get objects with a specific mimeType property |
name - String
|
Slug / post_name of the object |
nameIn - [String]
|
Specify objects to retrieve. Use slugs |
notIn - [ID]
|
Specify IDs NOT to retrieve. If this is used in the same query as "in", it will be ignored |
orderby - [PostObjectsConnectionOrderbyInput]
|
What parameter to use to order the objects by. |
parent - ID
|
Use ID to return only children. Use 0 to return only top-level items |
parentIn - [ID]
|
Specify objects whose parent is in an array |
parentNotIn - [ID]
|
Specify posts whose parent is not in an array |
password - String
|
Show posts with a specific password. |
search - String
|
Show Posts based on a keyword search |
stati - [PostStatusEnum]
|
Retrieve posts where post status is in an array. |
status - PostStatusEnum
|
Show posts with a specific status. |
title - String
|
Title of the object |
Example
{
"contentTypes": ["POST"],
"dateQuery": DateQueryInput,
"hasPassword": true,
"id": 123,
"in": [4],
"mimeType": "APPLICATION_MSWORD",
"name": "abc123",
"nameIn": ["abc123"],
"notIn": ["4"],
"orderby": [PostObjectsConnectionOrderbyInput],
"parent": "4",
"parentIn": ["4"],
"parentNotIn": [4],
"password": "abc123",
"search": "xyz789",
"stati": ["ACF_DISABLED"],
"status": "ACF_DISABLED",
"title": "xyz789"
}
CategoryToParentCategoryConnectionEdge
Description
Connection between the Category type and the category type
Example
{
"cursor": "xyz789",
"node": Category
}
CategoryToPostConnection
Description
Connection between the Category type and the post type
Fields
| Field Name | Description |
|---|---|
edges - [CategoryToPostConnectionEdge!]!
|
Edges for the CategoryToPostConnection connection |
nodes - [Post!]!
|
The nodes of the connection, without the edges |
pageInfo - CategoryToPostConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [CategoryToPostConnectionEdge],
"nodes": [Post],
"pageInfo": CategoryToPostConnectionPageInfo
}
CategoryToPostConnectionEdge
CategoryToPostConnectionPageInfo
Description
Page Info on the "CategoryToPostConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "abc123",
"hasNextPage": true,
"hasPreviousPage": false,
"startCursor": "xyz789"
}
CategoryToPostConnectionWhereArgs
Description
Arguments for filtering the CategoryToPostConnection connection
Fields
| Input Field | Description |
|---|---|
author - Int
|
The user that's connected as the author of the object. Use the userId for the author object. |
authorIn - [ID]
|
Find objects connected to author(s) in the array of author's userIds |
authorName - String
|
Find objects connected to the author by the author's nicename |
authorNotIn - [ID]
|
Find objects NOT connected to author(s) in the array of author's userIds |
categoryId - Int
|
Category ID |
categoryIn - [ID]
|
Array of category IDs, used to display objects from one category OR another |
categoryName - String
|
Use Category Slug |
categoryNotIn - [ID]
|
Array of category IDs, used to display objects from one category OR another |
dateQuery - DateQueryInput
|
Filter the connection based on dates |
hasPassword - Boolean
|
True for objects with passwords; False for objects without passwords; null for all objects with or without passwords |
id - Int
|
Specific database ID of the object |
in - [ID]
|
Array of IDs for the objects to retrieve |
mimeType - MimeTypeEnum
|
Get objects with a specific mimeType property |
name - String
|
Slug / post_name of the object |
nameIn - [String]
|
Specify objects to retrieve. Use slugs |
notIn - [ID]
|
Specify IDs NOT to retrieve. If this is used in the same query as "in", it will be ignored |
orderby - [PostObjectsConnectionOrderbyInput]
|
What parameter to use to order the objects by. |
parent - ID
|
Use ID to return only children. Use 0 to return only top-level items |
parentIn - [ID]
|
Specify objects whose parent is in an array |
parentNotIn - [ID]
|
Specify posts whose parent is not in an array |
password - String
|
Show posts with a specific password. |
search - String
|
Show Posts based on a keyword search |
stati - [PostStatusEnum]
|
Retrieve posts where post status is in an array. |
status - PostStatusEnum
|
Show posts with a specific status. |
tag - String
|
Tag Slug |
tagId - String
|
Use Tag ID |
tagIn - [ID]
|
Array of tag IDs, used to display objects from one tag OR another |
tagNotIn - [ID]
|
Array of tag IDs, used to display objects from one tag OR another |
tagSlugAnd - [String]
|
Array of tag slugs, used to display objects from one tag AND another |
tagSlugIn - [String]
|
Array of tag slugs, used to include objects in ANY specified tags |
title - String
|
Title of the object |
Example
{
"author": 123,
"authorIn": [4],
"authorName": "xyz789",
"authorNotIn": ["4"],
"categoryId": 987,
"categoryIn": [4],
"categoryName": "xyz789",
"categoryNotIn": ["4"],
"dateQuery": DateQueryInput,
"hasPassword": false,
"id": 123,
"in": ["4"],
"mimeType": "APPLICATION_MSWORD",
"name": "xyz789",
"nameIn": ["abc123"],
"notIn": [4],
"orderby": [PostObjectsConnectionOrderbyInput],
"parent": "4",
"parentIn": [4],
"parentNotIn": ["4"],
"password": "xyz789",
"search": "abc123",
"stati": ["ACF_DISABLED"],
"status": "ACF_DISABLED",
"tag": "xyz789",
"tagId": "xyz789",
"tagIn": ["4"],
"tagNotIn": ["4"],
"tagSlugAnd": ["abc123"],
"tagSlugIn": ["abc123"],
"title": "xyz789"
}
CategoryToTaxonomyConnectionEdge
Description
Connection between the Category type and the Taxonomy type
Example
{
"cursor": "abc123",
"node": Taxonomy
}
Collection
Description
The collection type
Fields
| Field Name | Description |
|---|---|
backgroundColor - String
|
Background Color |
collectionId - Int!
|
The id field matches the WP_Post->ID field. Deprecated in favor of the databaseId field |
contentType - ContentNodeToContentTypeConnectionEdge
|
Connection between the ContentNode type and the ContentType type |
contentTypeName - String!
|
The name of the Content Type the node belongs to |
databaseId - Int!
|
The unique identifier stored in the database |
date - String
|
Post publishing date. |
dateGmt - String
|
The publishing date set in GMT. |
description - String
|
Description |
desiredSlug - String
|
The desired slug of the post |
editingLockedBy - ContentNodeToEditLockConnectionEdge
|
If a user has edited the node within the past 15 seconds, this will return the user that last edited. Null if the edit lock doesn't exist or is greater than 15 seconds |
enclosure - String
|
The RSS enclosure for the object |
enqueuedScripts - ContentNodeToEnqueuedScriptConnection
|
Connection between the ContentNode type and the EnqueuedScript type |
Arguments
|
|
enqueuedStylesheets - ContentNodeToEnqueuedStylesheetConnection
|
Connection between the ContentNode type and the EnqueuedStylesheet type |
Arguments
|
|
expirationTime - String
|
Vanhentumisaika |
guid - String
|
The global unique identifier for this post. This currently matches the value stored in WP_Post->guid and the guid column in the "post_objects" database table. |
id - ID!
|
The globally unique identifier of the collection-cpt object. |
image - String
|
Image |
isComment - Boolean!
|
Whether the node is a Comment |
isContentNode - Boolean!
|
Whether the node is a Content Node |
isFrontPage - Boolean!
|
Whether the node represents the front page. |
isPostsPage - Boolean!
|
Whether the node represents the blog page. |
isPreview - Boolean
|
Whether the object is a node in the preview state |
isRestricted - Boolean
|
Whether the object is restricted from the current viewer |
isRevision - Boolean
|
True if the node is a revision of another node |
isTermNode - Boolean!
|
Whether the node is a Term |
language - Language
|
Polylang language |
lastEditedBy - ContentNodeToEditLastConnectionEdge
|
The user that most recently edited the node |
link - String
|
The permalink of the post |
modified - String
|
The local modified time for a post. If a post was recently updated the modified field will change to match the corresponding time. |
modifiedGmt - String
|
The GMT modified time for a post. If a post was recently updated the modified field will change to match the corresponding time in GMT. |
modules - [CollectionModulesUnionType]
|
List of modules |
preview - CollectionToPreviewConnectionEdge
|
Connection between the Collection type and the collection type |
previewRevisionDatabaseId - Int
|
The database id of the preview node |
previewRevisionId - ID
|
Whether the object is a node in the preview state |
revisionOf - NodeWithRevisionsToContentNodeConnectionEdge
|
If the current node is a revision, this field exposes the node this is a revision of. Returns null if the node is not a revision of another node. |
revisions - CollectionToRevisionConnection
|
Connection between the Collection type and the collection type |
Arguments
|
|
seo - SEO
|
The SEO Framework data of the collection |
showOnFrontPage - Boolean
|
Show on front page |
slug - String
|
The uri slug for the post. This is equivalent to the WP_Post->post_name field and the post_name column in the database for the "post_objects" table. |
status - String
|
The current status of the object |
template - ContentTemplate
|
The template assigned to the node |
title - String
|
The title of the post. This is currently just the raw title. An amendment to support rendered title needs to be made. |
Arguments
|
|
translation - Collection
|
Get specific translation version of this object |
Arguments
|
|
translations - [Collection]
|
List all translated versions of this post |
uri - String
|
The unique resource identifier path |
Example
{
"backgroundColor": "xyz789",
"collectionId": 987,
"contentType": ContentNodeToContentTypeConnectionEdge,
"contentTypeName": "abc123",
"databaseId": 123,
"date": "abc123",
"dateGmt": "xyz789",
"description": "abc123",
"desiredSlug": "abc123",
"editingLockedBy": ContentNodeToEditLockConnectionEdge,
"enclosure": "abc123",
"enqueuedScripts": ContentNodeToEnqueuedScriptConnection,
"enqueuedStylesheets": ContentNodeToEnqueuedStylesheetConnection,
"expirationTime": "xyz789",
"guid": "xyz789",
"id": "4",
"image": "abc123",
"isComment": true,
"isContentNode": false,
"isFrontPage": false,
"isPostsPage": true,
"isPreview": false,
"isRestricted": true,
"isRevision": true,
"isTermNode": false,
"language": Language,
"lastEditedBy": ContentNodeToEditLastConnectionEdge,
"link": "xyz789",
"modified": "abc123",
"modifiedGmt": "xyz789",
"modules": [EventSearch],
"preview": CollectionToPreviewConnectionEdge,
"previewRevisionDatabaseId": 123,
"previewRevisionId": 4,
"revisionOf": NodeWithRevisionsToContentNodeConnectionEdge,
"revisions": CollectionToRevisionConnection,
"seo": SEO,
"showOnFrontPage": true,
"slug": "abc123",
"status": "abc123",
"template": ContentTemplate,
"title": "abc123",
"translation": Collection,
"translations": [Collection],
"uri": "xyz789"
}
CollectionConnection
Description
Connection to collection Nodes
Fields
| Field Name | Description |
|---|---|
edges - [CollectionConnectionEdge!]!
|
A list of edges (relational context) between RootQuery and connected collection Nodes |
nodes - [Collection!]!
|
A list of connected collection Nodes |
pageInfo - CollectionConnectionPageInfo!
|
Information about pagination in a connection. |
Possible Types
| CollectionConnection Types |
|---|
Example
{
"edges": [CollectionConnectionEdge],
"nodes": [Collection],
"pageInfo": CollectionConnectionPageInfo
}
CollectionConnectionEdge
Description
Edge between a Node and a connected collection
Fields
| Field Name | Description |
|---|---|
cursor - String
|
Opaque reference to the nodes position in the connection. Value can be used with pagination args. |
node - Collection!
|
The connected collection Node |
Possible Types
| CollectionConnectionEdge Types |
|---|
Example
{
"cursor": "xyz789",
"node": Collection
}
CollectionConnectionPageInfo
Description
Page Info on the connected CollectionConnectionEdge
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Possible Types
| CollectionConnectionPageInfo Types |
|---|
Example
{
"endCursor": "abc123",
"hasNextPage": false,
"hasPreviousPage": true,
"startCursor": "abc123"
}
CollectionIdType
Description
The Type of Identifier used to fetch a single resource. Default is ID.
Values
| Enum Value | Description |
|---|---|
|
|
Identify a resource by the Database ID. |
|
|
Identify a resource by the (hashed) Global ID. |
|
|
Identify a resource by the slug. Available to non-hierarchcial Types where the slug is a unique identifier. |
|
|
Identify a resource by the URI. |
Example
"DATABASE_ID"
CollectionModulesUnionType
Example
EventSearch
CollectionToPreviewConnectionEdge
Description
Connection between the Collection type and the collection type
Fields
| Field Name | Description |
|---|---|
cursor - String
|
Opaque reference to the nodes position in the connection. Value can be used with pagination args. |
node - Collection!
|
The node of the connection, without the edges |
Example
{
"cursor": "abc123",
"node": Collection
}
CollectionToRevisionConnection
Description
Connection between the Collection type and the collection type
Fields
| Field Name | Description |
|---|---|
edges - [CollectionToRevisionConnectionEdge!]!
|
Edges for the CollectionToRevisionConnection connection |
nodes - [Collection!]!
|
The nodes of the connection, without the edges |
pageInfo - CollectionToRevisionConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [CollectionToRevisionConnectionEdge],
"nodes": [Collection],
"pageInfo": CollectionToRevisionConnectionPageInfo
}
CollectionToRevisionConnectionEdge
Description
An edge in a connection
Fields
| Field Name | Description |
|---|---|
cursor - String
|
A cursor for use in pagination |
node - Collection!
|
The item at the end of the edge |
Example
{
"cursor": "abc123",
"node": Collection
}
CollectionToRevisionConnectionPageInfo
Description
Page Info on the "CollectionToRevisionConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "xyz789",
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "abc123"
}
CollectionToRevisionConnectionWhereArgs
Description
Arguments for filtering the CollectionToRevisionConnection connection
Fields
| Input Field | Description |
|---|---|
dateQuery - DateQueryInput
|
Filter the connection based on dates |
hasPassword - Boolean
|
True for objects with passwords; False for objects without passwords; null for all objects with or without passwords |
id - Int
|
Specific database ID of the object |
in - [ID]
|
Array of IDs for the objects to retrieve |
mimeType - MimeTypeEnum
|
Get objects with a specific mimeType property |
name - String
|
Slug / post_name of the object |
nameIn - [String]
|
Specify objects to retrieve. Use slugs |
notIn - [ID]
|
Specify IDs NOT to retrieve. If this is used in the same query as "in", it will be ignored |
orderby - [PostObjectsConnectionOrderbyInput]
|
What parameter to use to order the objects by. |
parent - ID
|
Use ID to return only children. Use 0 to return only top-level items |
parentIn - [ID]
|
Specify objects whose parent is in an array |
parentNotIn - [ID]
|
Specify posts whose parent is not in an array |
password - String
|
Show posts with a specific password. |
search - String
|
Show Posts based on a keyword search |
stati - [PostStatusEnum]
|
Retrieve posts where post status is in an array. |
status - PostStatusEnum
|
Show posts with a specific status. |
title - String
|
Title of the object |
Example
{
"dateQuery": DateQueryInput,
"hasPassword": false,
"id": 123,
"in": [4],
"mimeType": "APPLICATION_MSWORD",
"name": "abc123",
"nameIn": ["abc123"],
"notIn": ["4"],
"orderby": [PostObjectsConnectionOrderbyInput],
"parent": "4",
"parentIn": [4],
"parentNotIn": ["4"],
"password": "xyz789",
"search": "xyz789",
"stati": ["ACF_DISABLED"],
"status": "ACF_DISABLED",
"title": "xyz789"
}
Comment
Description
A Comment object
Fields
| Field Name | Description |
|---|---|
agent - String
|
User agent used to post the comment. This field is equivalent to WP_Comment->comment_agent and the value matching the "comment_agent" column in SQL. |
approved - Boolean
|
The approval status of the comment. This field is equivalent to WP_Comment->comment_approved and the value matching the "comment_approved" column in SQL. Deprecated in favor of the status field
|
author - CommentToCommenterConnectionEdge
|
The author of the comment |
authorIp - String
|
IP address for the author. This field is equivalent to WP_Comment->comment_author_IP and the value matching the "comment_author_IP" column in SQL. |
commentId - Int
|
ID for the comment, unique among comments. Deprecated in favor of databaseId |
commentedOn - CommentToContentNodeConnectionEdge
|
Connection between the Comment type and the ContentNode type |
content - String
|
Content of the comment. This field is equivalent to WP_Comment->comment_content and the value matching the "comment_content" column in SQL. |
Arguments
|
|
databaseId - Int!
|
The unique identifier stored in the database |
date - String
|
Date the comment was posted in local time. This field is equivalent to WP_Comment->date and the value matching the "date" column in SQL. |
dateGmt - String
|
Date the comment was posted in GMT. This field is equivalent to WP_Comment->date_gmt and the value matching the "date_gmt" column in SQL. |
id - ID!
|
The globally unique identifier for the comment object |
isComment - Boolean!
|
Whether the node is a Comment |
isContentNode - Boolean!
|
Whether the node is a Content Node |
isFrontPage - Boolean!
|
Whether the node represents the front page. |
isPostsPage - Boolean!
|
Whether the node represents the blog page. |
isRestricted - Boolean
|
Whether the object is restricted from the current viewer |
isTermNode - Boolean!
|
Whether the node is a Term |
karma - Int
|
Karma value for the comment. This field is equivalent to WP_Comment->comment_karma and the value matching the "comment_karma" column in SQL. |
link - String
|
The permalink of the comment |
parent - CommentToParentCommentConnectionEdge
|
Connection between the Comment type and the Comment type |
Arguments
|
|
parentDatabaseId - Int
|
The database id of the parent comment node or null if it is the root comment |
parentId - ID
|
The globally unique identifier of the parent comment node. |
replies - CommentToCommentConnection
|
Connection between the Comment type and the Comment type |
Arguments
|
|
status - CommentStatusEnum
|
The approval status of the comment. This field is equivalent to WP_Comment->comment_approved and the value matching the "comment_approved" column in SQL. |
type - String
|
Type of comment. This field is equivalent to WP_Comment->comment_type and the value matching the "comment_type" column in SQL. |
uri - String
|
The unique resource identifier path |
Example
{
"agent": "abc123",
"approved": true,
"author": CommentToCommenterConnectionEdge,
"authorIp": "abc123",
"commentId": 987,
"commentedOn": CommentToContentNodeConnectionEdge,
"content": "abc123",
"databaseId": 123,
"date": "xyz789",
"dateGmt": "abc123",
"id": 4,
"isComment": false,
"isContentNode": false,
"isFrontPage": false,
"isPostsPage": true,
"isRestricted": true,
"isTermNode": true,
"karma": 987,
"link": "xyz789",
"parent": CommentToParentCommentConnectionEdge,
"parentDatabaseId": 123,
"parentId": "4",
"replies": CommentToCommentConnection,
"status": "APPROVE",
"type": "abc123",
"uri": "xyz789"
}
CommentAuthor
Description
A Comment Author object
Fields
| Field Name | Description |
|---|---|
avatar - Avatar
|
Avatar object for user. The avatar object can be retrieved in different sizes by specifying the size argument. |
Arguments
|
|
databaseId - Int!
|
The unique identifier stored in the database |
email - String
|
The email for the comment author |
id - ID!
|
The globally unique identifier for the comment author object |
isRestricted - Boolean
|
Whether the object is restricted from the current viewer |
name - String
|
The name for the comment author. |
url - String
|
The url the comment author. |
Example
{
"avatar": Avatar,
"databaseId": 987,
"email": "abc123",
"id": "4",
"isRestricted": true,
"name": "xyz789",
"url": "abc123"
}
CommentConnection
Description
Connection to Comment Nodes
Fields
| Field Name | Description |
|---|---|
edges - [CommentConnectionEdge!]!
|
A list of edges (relational context) between RootQuery and connected Comment Nodes |
nodes - [Comment!]!
|
A list of connected Comment Nodes |
pageInfo - CommentConnectionPageInfo!
|
Information about pagination in a connection. |
Possible Types
| CommentConnection Types |
|---|
Example
{
"edges": [CommentConnectionEdge],
"nodes": [Comment],
"pageInfo": CommentConnectionPageInfo
}
CommentConnectionEdge
Description
Edge between a Node and a connected Comment
Fields
| Field Name | Description |
|---|---|
cursor - String
|
Opaque reference to the nodes position in the connection. Value can be used with pagination args. |
node - Comment!
|
The connected Comment Node |
Possible Types
| CommentConnectionEdge Types |
|---|
Example
{
"cursor": "xyz789",
"node": Comment
}
CommentConnectionPageInfo
Description
Page Info on the connected CommentConnectionEdge
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Possible Types
| CommentConnectionPageInfo Types |
|---|
Example
{
"endCursor": "xyz789",
"hasNextPage": true,
"hasPreviousPage": false,
"startCursor": "abc123"
}
CommentNodeIdTypeEnum
Description
The Type of Identifier used to fetch a single comment node. Default is "ID". To be used along with the "id" field.
Values
| Enum Value | Description |
|---|---|
|
|
Identify a resource by the Database ID. |
|
|
Identify a resource by the (hashed) Global ID. |
Example
"DATABASE_ID"
CommentStatusEnum
Description
The status of the comment object.
Values
| Enum Value | Description |
|---|---|
|
|
Comments with the Hyväksytty status |
|
|
Comments with the Hylätyt status |
|
|
Comments with the Roskaviesti status |
|
|
Comments with the Roskakorissa status |
Example
"APPROVE"
CommentToCommentConnection
Description
Connection between the Comment type and the Comment type
Fields
| Field Name | Description |
|---|---|
edges - [CommentToCommentConnectionEdge!]!
|
Edges for the CommentToCommentConnection connection |
nodes - [Comment!]!
|
The nodes of the connection, without the edges |
pageInfo - CommentToCommentConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [CommentToCommentConnectionEdge],
"nodes": [Comment],
"pageInfo": CommentToCommentConnectionPageInfo
}
CommentToCommentConnectionEdge
CommentToCommentConnectionPageInfo
Description
Page Info on the "CommentToCommentConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "xyz789",
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "abc123"
}
CommentToCommentConnectionWhereArgs
Description
Arguments for filtering the CommentToCommentConnection connection
Fields
| Input Field | Description |
|---|---|
authorEmail - String
|
Comment author email address. |
authorIn - [ID]
|
Array of author IDs to include comments for. |
authorNotIn - [ID]
|
Array of author IDs to exclude comments for. |
authorUrl - String
|
Comment author URL. |
commentIn - [ID]
|
Array of comment IDs to include. |
commentNotIn - [ID]
|
Array of IDs of users whose unapproved comments will be returned by the query regardless of status. |
commentType - String
|
Include comments of a given type. |
commentTypeIn - [String]
|
Include comments from a given array of comment types. |
commentTypeNotIn - String
|
Exclude comments from a given array of comment types. |
contentAuthor - [ID]
|
Content object author ID to limit results by. |
contentAuthorIn - [ID]
|
Array of author IDs to retrieve comments for. |
contentAuthorNotIn - [ID]
|
Array of author IDs not to retrieve comments for. |
contentId - ID
|
Limit results to those affiliated with a given content object ID. |
contentIdIn - [ID]
|
Array of content object IDs to include affiliated comments for. |
contentIdNotIn - [ID]
|
Array of content object IDs to exclude affiliated comments for. |
contentName - String
|
Content object name (i.e. slug ) to retrieve affiliated comments for. |
contentParent - Int
|
Content Object parent ID to retrieve affiliated comments for. |
contentStatus - [PostStatusEnum]
|
Array of content object statuses to retrieve affiliated comments for. Pass 'any' to match any value. |
contentType - [ContentTypeEnum]
|
Content object type or array of types to retrieve affiliated comments for. Pass 'any' to match any value. |
includeUnapproved - [ID]
|
Array of IDs or email addresses of users whose unapproved comments will be returned by the query regardless of $status. Default empty |
karma - Int
|
Karma score to retrieve matching comments for. |
order - OrderEnum
|
The cardinality of the order of the connection |
orderby - CommentsConnectionOrderbyEnum
|
Field to order the comments by. |
parent - Int
|
Parent ID of comment to retrieve children of. |
parentIn - [ID]
|
Array of parent IDs of comments to retrieve children for. |
parentNotIn - [ID]
|
Array of parent IDs of comments not to retrieve children for. |
search - String
|
Search term(s) to retrieve matching comments for. |
status - String
|
Comment status to limit results by. |
userId - ID
|
Include comments for a specific user ID. |
Example
{
"authorEmail": "xyz789",
"authorIn": [4],
"authorNotIn": [4],
"authorUrl": "xyz789",
"commentIn": [4],
"commentNotIn": ["4"],
"commentType": "xyz789",
"commentTypeIn": ["xyz789"],
"commentTypeNotIn": "xyz789",
"contentAuthor": ["4"],
"contentAuthorIn": ["4"],
"contentAuthorNotIn": [4],
"contentId": "4",
"contentIdIn": ["4"],
"contentIdNotIn": ["4"],
"contentName": "xyz789",
"contentParent": 987,
"contentStatus": ["ACF_DISABLED"],
"contentType": ["ATTACHMENT"],
"includeUnapproved": [4],
"karma": 987,
"order": "ASC",
"orderby": "COMMENT_AGENT",
"parent": 123,
"parentIn": [4],
"parentNotIn": ["4"],
"search": "xyz789",
"status": "abc123",
"userId": 4
}
CommentToCommenterConnectionEdge
Description
Connection between the Comment type and the Commenter type
Fields
| Field Name | Description |
|---|---|
cursor - String
|
Opaque reference to the nodes position in the connection. Value can be used with pagination args. |
node - Commenter!
|
The node of the connection, without the edges |
Example
{
"cursor": "xyz789",
"node": Commenter
}
CommentToContentNodeConnectionEdge
Description
Connection between the Comment type and the ContentNode type
Fields
| Field Name | Description |
|---|---|
cursor - String
|
Opaque reference to the nodes position in the connection. Value can be used with pagination args. |
node - ContentNode!
|
The node of the connection, without the edges |
Example
{
"cursor": "abc123",
"node": ContentNode
}
CommentToParentCommentConnectionEdge
Description
Connection between the Comment type and the Comment type
Example
{
"cursor": "abc123",
"node": Comment
}
CommentToParentCommentConnectionWhereArgs
Description
Arguments for filtering the CommentToParentCommentConnection connection
Fields
| Input Field | Description |
|---|---|
authorEmail - String
|
Comment author email address. |
authorIn - [ID]
|
Array of author IDs to include comments for. |
authorNotIn - [ID]
|
Array of author IDs to exclude comments for. |
authorUrl - String
|
Comment author URL. |
commentIn - [ID]
|
Array of comment IDs to include. |
commentNotIn - [ID]
|
Array of IDs of users whose unapproved comments will be returned by the query regardless of status. |
commentType - String
|
Include comments of a given type. |
commentTypeIn - [String]
|
Include comments from a given array of comment types. |
commentTypeNotIn - String
|
Exclude comments from a given array of comment types. |
contentAuthor - [ID]
|
Content object author ID to limit results by. |
contentAuthorIn - [ID]
|
Array of author IDs to retrieve comments for. |
contentAuthorNotIn - [ID]
|
Array of author IDs not to retrieve comments for. |
contentId - ID
|
Limit results to those affiliated with a given content object ID. |
contentIdIn - [ID]
|
Array of content object IDs to include affiliated comments for. |
contentIdNotIn - [ID]
|
Array of content object IDs to exclude affiliated comments for. |
contentName - String
|
Content object name (i.e. slug ) to retrieve affiliated comments for. |
contentParent - Int
|
Content Object parent ID to retrieve affiliated comments for. |
contentStatus - [PostStatusEnum]
|
Array of content object statuses to retrieve affiliated comments for. Pass 'any' to match any value. |
contentType - [ContentTypeEnum]
|
Content object type or array of types to retrieve affiliated comments for. Pass 'any' to match any value. |
includeUnapproved - [ID]
|
Array of IDs or email addresses of users whose unapproved comments will be returned by the query regardless of $status. Default empty |
karma - Int
|
Karma score to retrieve matching comments for. |
order - OrderEnum
|
The cardinality of the order of the connection |
orderby - CommentsConnectionOrderbyEnum
|
Field to order the comments by. |
parent - Int
|
Parent ID of comment to retrieve children of. |
parentIn - [ID]
|
Array of parent IDs of comments to retrieve children for. |
parentNotIn - [ID]
|
Array of parent IDs of comments not to retrieve children for. |
search - String
|
Search term(s) to retrieve matching comments for. |
status - String
|
Comment status to limit results by. |
userId - ID
|
Include comments for a specific user ID. |
Example
{
"authorEmail": "xyz789",
"authorIn": [4],
"authorNotIn": [4],
"authorUrl": "abc123",
"commentIn": [4],
"commentNotIn": ["4"],
"commentType": "xyz789",
"commentTypeIn": ["abc123"],
"commentTypeNotIn": "abc123",
"contentAuthor": [4],
"contentAuthorIn": ["4"],
"contentAuthorNotIn": ["4"],
"contentId": "4",
"contentIdIn": [4],
"contentIdNotIn": [4],
"contentName": "abc123",
"contentParent": 987,
"contentStatus": ["ACF_DISABLED"],
"contentType": ["ATTACHMENT"],
"includeUnapproved": [4],
"karma": 123,
"order": "ASC",
"orderby": "COMMENT_AGENT",
"parent": 987,
"parentIn": ["4"],
"parentNotIn": [4],
"search": "xyz789",
"status": "abc123",
"userId": "4"
}
Commenter
Description
The author of a comment
Fields
| Field Name | Description |
|---|---|
avatar - Avatar
|
Avatar object for user. The avatar object can be retrieved in different sizes by specifying the size argument. |
databaseId - Int!
|
Identifies the primary key from the database. |
email - String
|
The email address of the author of a comment. |
id - ID!
|
The globally unique identifier for the comment author. |
isRestricted - Boolean
|
Whether the author information is considered restricted. (not fully public) |
name - String
|
The name of the author of a comment. |
url - String
|
The url of the author of a comment. |
Possible Types
| Commenter Types |
|---|
Example
{
"avatar": Avatar,
"databaseId": 123,
"email": "abc123",
"id": "4",
"isRestricted": true,
"name": "xyz789",
"url": "xyz789"
}
CommenterConnectionEdge
Description
Edge between a Node and a connected Commenter
Fields
| Field Name | Description |
|---|---|
cursor - String
|
Opaque reference to the nodes position in the connection. Value can be used with pagination args. |
node - Commenter!
|
The connected Commenter Node |
Possible Types
| CommenterConnectionEdge Types |
|---|
Example
{
"cursor": "xyz789",
"node": Commenter
}
CommentsConnectionOrderbyEnum
Description
Options for ordering the connection
Values
| Enum Value | Description |
|---|---|
|
|
Order by browser user agent of the commenter. |
|
|
Order by approval status of the comment. |
|
|
Order by name of the comment author. |
|
|
Order by e-mail of the comment author. |
|
|
Order by IP address of the comment author. |
|
|
Order by URL address of the comment author. |
|
|
Order by the comment contents. |
|
|
Order by date/time timestamp of the comment. |
|
|
Order by GMT timezone date/time timestamp of the comment. |
|
|
Order by the globally unique identifier for the comment object |
|
|
Order by the array list of comment IDs listed in the where clause. |
|
|
Order by the comment karma score. |
|
|
Order by the comment parent ID. |
|
|
Order by the post object ID. |
|
|
Order by the the type of comment, such as 'comment', 'pingback', or 'trackback'. |
|
|
Order by the user ID. |
Example
"COMMENT_AGENT"
Connection
Description
A plural connection from one Node Type in the Graph to another Node Type, with support for relational data via "edges".
Fields
| Field Name | Description |
|---|---|
edges - [Edge!]!
|
A list of edges (relational context) between connected nodes |
nodes - [Node!]!
|
A list of connected nodes |
pageInfo - PageInfo!
|
Information about pagination in a connection. |
Possible Types
| Connection Types |
|---|
Example
{
"edges": [Edge],
"nodes": [Node],
"pageInfo": PageInfo
}
Contact
Description
The contact type
Fields
| Field Name | Description |
|---|---|
contactId - Int!
|
The id field matches the WP_Post->ID field. Deprecated in favor of the databaseId field |
contentType - ContentNodeToContentTypeConnectionEdge
|
Connection between the ContentNode type and the ContentType type |
contentTypeName - String!
|
The name of the Content Type the node belongs to |
databaseId - Int!
|
The unique identifier stored in the database |
date - String
|
Post publishing date. |
dateGmt - String
|
The publishing date set in GMT. |
description - String
|
Description |
desiredSlug - String
|
The desired slug of the post |
editingLockedBy - ContentNodeToEditLockConnectionEdge
|
If a user has edited the node within the past 15 seconds, this will return the user that last edited. Null if the edit lock doesn't exist or is greater than 15 seconds |
enclosure - String
|
The RSS enclosure for the object |
enqueuedScripts - ContentNodeToEnqueuedScriptConnection
|
Connection between the ContentNode type and the EnqueuedScript type |
Arguments
|
|
enqueuedStylesheets - ContentNodeToEnqueuedStylesheetConnection
|
Connection between the ContentNode type and the EnqueuedStylesheet type |
Arguments
|
|
featuredImage - NodeWithFeaturedImageToMediaItemConnectionEdge
|
Connection between the NodeWithFeaturedImage type and the MediaItem type |
featuredImageDatabaseId - Int
|
The database identifier for the featured image node assigned to the content node |
featuredImageId - ID
|
Globally unique ID of the featured image assigned to the node |
firstName - String
|
First name |
guid - String
|
The global unique identifier for this post. This currently matches the value stored in WP_Post->guid and the guid column in the "post_objects" database table. |
id - ID!
|
The globally unique identifier of the contact-cpt object. |
isComment - Boolean!
|
Whether the node is a Comment |
isContentNode - Boolean!
|
Whether the node is a Content Node |
isFrontPage - Boolean!
|
Whether the node represents the front page. |
isPostsPage - Boolean!
|
Whether the node represents the blog page. |
isPreview - Boolean
|
Whether the object is a node in the preview state |
isRestricted - Boolean
|
Whether the object is restricted from the current viewer |
isRevision - Boolean
|
True if the node is a revision of another node |
isTermNode - Boolean!
|
Whether the node is a Term |
jobTitle - String
|
Job Title |
language - Language
|
Polylang language |
lastEditedBy - ContentNodeToEditLastConnectionEdge
|
The user that most recently edited the node |
lastName - String
|
Last name |
link - String
|
The permalink of the post |
modified - String
|
The local modified time for a post. If a post was recently updated the modified field will change to match the corresponding time. |
modifiedGmt - String
|
The GMT modified time for a post. If a post was recently updated the modified field will change to match the corresponding time in GMT. |
preview - ContactToPreviewConnectionEdge
|
Connection between the Contact type and the contact type |
previewRevisionDatabaseId - Int
|
The database id of the preview node |
previewRevisionId - ID
|
Whether the object is a node in the preview state |
revisionOf - NodeWithRevisionsToContentNodeConnectionEdge
|
If the current node is a revision, this field exposes the node this is a revision of. Returns null if the node is not a revision of another node. |
revisions - ContactToRevisionConnection
|
Connection between the Contact type and the contact type |
Arguments
|
|
seo - SEO
|
The SEO Framework data of the contact |
slug - String
|
The uri slug for the post. This is equivalent to the WP_Post->post_name field and the post_name column in the database for the "post_objects" table. |
status - String
|
The current status of the object |
template - ContentTemplate
|
The template assigned to the node |
title - String
|
The title of the post. This is currently just the raw title. An amendment to support rendered title needs to be made. |
Arguments
|
|
translation - Contact
|
Get specific translation version of this object |
Arguments
|
|
translations - [Contact]
|
List all translated versions of this post |
uri - String
|
The unique resource identifier path |
Example
{
"contactId": 987,
"contentType": ContentNodeToContentTypeConnectionEdge,
"contentTypeName": "abc123",
"databaseId": 987,
"date": "abc123",
"dateGmt": "xyz789",
"description": "abc123",
"desiredSlug": "xyz789",
"editingLockedBy": ContentNodeToEditLockConnectionEdge,
"enclosure": "abc123",
"enqueuedScripts": ContentNodeToEnqueuedScriptConnection,
"enqueuedStylesheets": ContentNodeToEnqueuedStylesheetConnection,
"featuredImage": NodeWithFeaturedImageToMediaItemConnectionEdge,
"featuredImageDatabaseId": 987,
"featuredImageId": 4,
"firstName": "xyz789",
"guid": "abc123",
"id": "4",
"isComment": false,
"isContentNode": false,
"isFrontPage": false,
"isPostsPage": true,
"isPreview": false,
"isRestricted": true,
"isRevision": true,
"isTermNode": true,
"jobTitle": "xyz789",
"language": Language,
"lastEditedBy": ContentNodeToEditLastConnectionEdge,
"lastName": "xyz789",
"link": "abc123",
"modified": "xyz789",
"modifiedGmt": "xyz789",
"preview": ContactToPreviewConnectionEdge,
"previewRevisionDatabaseId": 123,
"previewRevisionId": 4,
"revisionOf": NodeWithRevisionsToContentNodeConnectionEdge,
"revisions": ContactToRevisionConnection,
"seo": SEO,
"slug": "abc123",
"status": "abc123",
"template": ContentTemplate,
"title": "abc123",
"translation": Contact,
"translations": [Contact],
"uri": "xyz789"
}
ContactConnection
Description
Connection to contact Nodes
Fields
| Field Name | Description |
|---|---|
edges - [ContactConnectionEdge!]!
|
A list of edges (relational context) between RootQuery and connected contact Nodes |
nodes - [Contact!]!
|
A list of connected contact Nodes |
pageInfo - ContactConnectionPageInfo!
|
Information about pagination in a connection. |
Possible Types
| ContactConnection Types |
|---|
Example
{
"edges": [ContactConnectionEdge],
"nodes": [Contact],
"pageInfo": ContactConnectionPageInfo
}
ContactConnectionEdge
Description
Edge between a Node and a connected contact
Fields
| Field Name | Description |
|---|---|
cursor - String
|
Opaque reference to the nodes position in the connection. Value can be used with pagination args. |
node - Contact!
|
The connected contact Node |
Possible Types
| ContactConnectionEdge Types |
|---|
Example
{
"cursor": "xyz789",
"node": Contact
}
ContactConnectionPageInfo
Description
Page Info on the connected ContactConnectionEdge
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Possible Types
| ContactConnectionPageInfo Types |
|---|
Example
{
"endCursor": "abc123",
"hasNextPage": false,
"hasPreviousPage": false,
"startCursor": "xyz789"
}
ContactIdType
Description
The Type of Identifier used to fetch a single resource. Default is ID.
Values
| Enum Value | Description |
|---|---|
|
|
Identify a resource by the Database ID. |
|
|
Identify a resource by the (hashed) Global ID. |
|
|
Identify a resource by the slug. Available to non-hierarchcial Types where the slug is a unique identifier. |
|
|
Identify a resource by the URI. |
Example
"DATABASE_ID"
ContactToPreviewConnectionEdge
Description
Connection between the Contact type and the contact type
Example
{
"cursor": "abc123",
"node": Contact
}
ContactToRevisionConnection
Description
Connection between the Contact type and the contact type
Fields
| Field Name | Description |
|---|---|
edges - [ContactToRevisionConnectionEdge!]!
|
Edges for the ContactToRevisionConnection connection |
nodes - [Contact!]!
|
The nodes of the connection, without the edges |
pageInfo - ContactToRevisionConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [ContactToRevisionConnectionEdge],
"nodes": [Contact],
"pageInfo": ContactToRevisionConnectionPageInfo
}
ContactToRevisionConnectionEdge
ContactToRevisionConnectionPageInfo
Description
Page Info on the "ContactToRevisionConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "abc123",
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "xyz789"
}
ContactToRevisionConnectionWhereArgs
Description
Arguments for filtering the ContactToRevisionConnection connection
Fields
| Input Field | Description |
|---|---|
dateQuery - DateQueryInput
|
Filter the connection based on dates |
hasPassword - Boolean
|
True for objects with passwords; False for objects without passwords; null for all objects with or without passwords |
id - Int
|
Specific database ID of the object |
in - [ID]
|
Array of IDs for the objects to retrieve |
mimeType - MimeTypeEnum
|
Get objects with a specific mimeType property |
name - String
|
Slug / post_name of the object |
nameIn - [String]
|
Specify objects to retrieve. Use slugs |
notIn - [ID]
|
Specify IDs NOT to retrieve. If this is used in the same query as "in", it will be ignored |
orderby - [PostObjectsConnectionOrderbyInput]
|
What parameter to use to order the objects by. |
parent - ID
|
Use ID to return only children. Use 0 to return only top-level items |
parentIn - [ID]
|
Specify objects whose parent is in an array |
parentNotIn - [ID]
|
Specify posts whose parent is not in an array |
password - String
|
Show posts with a specific password. |
search - String
|
Show Posts based on a keyword search |
stati - [PostStatusEnum]
|
Retrieve posts where post status is in an array. |
status - PostStatusEnum
|
Show posts with a specific status. |
title - String
|
Title of the object |
Example
{
"dateQuery": DateQueryInput,
"hasPassword": true,
"id": 123,
"in": [4],
"mimeType": "APPLICATION_MSWORD",
"name": "xyz789",
"nameIn": ["xyz789"],
"notIn": ["4"],
"orderby": [PostObjectsConnectionOrderbyInput],
"parent": "4",
"parentIn": [4],
"parentNotIn": [4],
"password": "xyz789",
"search": "xyz789",
"stati": ["ACF_DISABLED"],
"status": "ACF_DISABLED",
"title": "xyz789"
}
ContentNode
Description
Nodes used to manage content
Fields
| Field Name | Description |
|---|---|
contentType - ContentNodeToContentTypeConnectionEdge
|
Connection between the ContentNode type and the ContentType type |
contentTypeName - String!
|
The name of the Content Type the node belongs to |
databaseId - Int!
|
The ID of the node in the database. |
date - String
|
Post publishing date. |
dateGmt - String
|
The publishing date set in GMT. |
desiredSlug - String
|
The desired slug of the post |
editingLockedBy - ContentNodeToEditLockConnectionEdge
|
If a user has edited the node within the past 15 seconds, this will return the user that last edited. Null if the edit lock doesn't exist or is greater than 15 seconds |
enclosure - String
|
The RSS enclosure for the object |
enqueuedScripts - ContentNodeToEnqueuedScriptConnection
|
Connection between the ContentNode type and the EnqueuedScript type |
Arguments
|
|
enqueuedStylesheets - ContentNodeToEnqueuedStylesheetConnection
|
Connection between the ContentNode type and the EnqueuedStylesheet type |
Arguments
|
|
guid - String
|
The global unique identifier for this post. This currently matches the value stored in WP_Post->guid and the guid column in the "post_objects" database table. |
id - ID!
|
The globally unique ID for the object |
isComment - Boolean!
|
Whether the node is a Comment |
isContentNode - Boolean!
|
Whether the node is a Content Node |
isFrontPage - Boolean!
|
Whether the node represents the front page. |
isPostsPage - Boolean!
|
Whether the node represents the blog page. |
isPreview - Boolean
|
Whether the object is a node in the preview state |
isRestricted - Boolean
|
Whether the object is restricted from the current viewer |
isTermNode - Boolean!
|
Whether the node is a Term |
lastEditedBy - ContentNodeToEditLastConnectionEdge
|
The user that most recently edited the node |
link - String
|
The permalink of the post |
modified - String
|
The local modified time for a post. If a post was recently updated the modified field will change to match the corresponding time. |
modifiedGmt - String
|
The GMT modified time for a post. If a post was recently updated the modified field will change to match the corresponding time in GMT. |
previewRevisionDatabaseId - Int
|
The database id of the preview node |
previewRevisionId - ID
|
Whether the object is a node in the preview state |
slug - String
|
The uri slug for the post. This is equivalent to the WP_Post->post_name field and the post_name column in the database for the "post_objects" table. |
status - String
|
The current status of the object |
template - ContentTemplate
|
The template assigned to a node of content |
uri - String
|
The unique resource identifier path |
Possible Types
| ContentNode Types |
|---|
Example
{
"contentType": ContentNodeToContentTypeConnectionEdge,
"contentTypeName": "xyz789",
"databaseId": 987,
"date": "xyz789",
"dateGmt": "xyz789",
"desiredSlug": "xyz789",
"editingLockedBy": ContentNodeToEditLockConnectionEdge,
"enclosure": "xyz789",
"enqueuedScripts": ContentNodeToEnqueuedScriptConnection,
"enqueuedStylesheets": ContentNodeToEnqueuedStylesheetConnection,
"guid": "abc123",
"id": 4,
"isComment": true,
"isContentNode": false,
"isFrontPage": false,
"isPostsPage": false,
"isPreview": true,
"isRestricted": false,
"isTermNode": false,
"lastEditedBy": ContentNodeToEditLastConnectionEdge,
"link": "xyz789",
"modified": "xyz789",
"modifiedGmt": "abc123",
"previewRevisionDatabaseId": 987,
"previewRevisionId": 4,
"slug": "xyz789",
"status": "xyz789",
"template": ContentTemplate,
"uri": "abc123"
}
ContentNodeConnection
Description
Connection to ContentNode Nodes
Fields
| Field Name | Description |
|---|---|
edges - [ContentNodeConnectionEdge!]!
|
A list of edges (relational context) between ContentType and connected ContentNode Nodes |
nodes - [ContentNode!]!
|
A list of connected ContentNode Nodes |
pageInfo - ContentNodeConnectionPageInfo!
|
Information about pagination in a connection. |
Possible Types
| ContentNodeConnection Types |
|---|
Example
{
"edges": [ContentNodeConnectionEdge],
"nodes": [ContentNode],
"pageInfo": ContentNodeConnectionPageInfo
}
ContentNodeConnectionEdge
Description
Edge between a Node and a connected ContentNode
Fields
| Field Name | Description |
|---|---|
cursor - String
|
Opaque reference to the nodes position in the connection. Value can be used with pagination args. |
node - ContentNode!
|
The connected ContentNode Node |
Possible Types
| ContentNodeConnectionEdge Types |
|---|
Example
{
"cursor": "xyz789",
"node": ContentNode
}
ContentNodeConnectionPageInfo
Description
Page Info on the connected ContentNodeConnectionEdge
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Possible Types
| ContentNodeConnectionPageInfo Types |
|---|
|
|
|
|
Example
{
"endCursor": "xyz789",
"hasNextPage": true,
"hasPreviousPage": false,
"startCursor": "abc123"
}
ContentNodeIdTypeEnum
Description
The Type of Identifier used to fetch a single resource. Default is ID.
Values
| Enum Value | Description |
|---|---|
|
|
Identify a resource by the Database ID. |
|
|
Identify a resource by the (hashed) Global ID. |
|
|
Identify a resource by the URI. |
Example
"DATABASE_ID"
ContentNodeToContentTypeConnectionEdge
Description
Connection between the ContentNode type and the ContentType type
Fields
| Field Name | Description |
|---|---|
cursor - String
|
Opaque reference to the nodes position in the connection. Value can be used with pagination args. |
node - ContentType!
|
The node of the connection, without the edges |
Example
{
"cursor": "abc123",
"node": ContentType
}
ContentNodeToEditLastConnectionEdge
Description
Connection between the ContentNode type and the User type
Example
{
"cursor": "abc123",
"node": User
}
ContentNodeToEditLockConnectionEdge
Description
Connection between the ContentNode type and the User type
Example
{
"cursor": "abc123",
"lockTimestamp": "abc123",
"node": User
}
ContentNodeToEnqueuedScriptConnection
Description
Connection between the ContentNode type and the EnqueuedScript type
Fields
| Field Name | Description |
|---|---|
edges - [ContentNodeToEnqueuedScriptConnectionEdge!]!
|
Edges for the ContentNodeToEnqueuedScriptConnection connection |
nodes - [EnqueuedScript!]!
|
The nodes of the connection, without the edges |
pageInfo - ContentNodeToEnqueuedScriptConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [ContentNodeToEnqueuedScriptConnectionEdge],
"nodes": [EnqueuedScript],
"pageInfo": ContentNodeToEnqueuedScriptConnectionPageInfo
}
ContentNodeToEnqueuedScriptConnectionEdge
Description
An edge in a connection
Fields
| Field Name | Description |
|---|---|
cursor - String
|
A cursor for use in pagination |
node - EnqueuedScript!
|
The item at the end of the edge |
Example
{
"cursor": "xyz789",
"node": EnqueuedScript
}
ContentNodeToEnqueuedScriptConnectionPageInfo
Description
Page Info on the "ContentNodeToEnqueuedScriptConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "xyz789",
"hasNextPage": false,
"hasPreviousPage": true,
"startCursor": "xyz789"
}
ContentNodeToEnqueuedStylesheetConnection
Description
Connection between the ContentNode type and the EnqueuedStylesheet type
Fields
| Field Name | Description |
|---|---|
edges - [ContentNodeToEnqueuedStylesheetConnectionEdge!]!
|
Edges for the ContentNodeToEnqueuedStylesheetConnection connection |
nodes - [EnqueuedStylesheet!]!
|
The nodes of the connection, without the edges |
pageInfo - ContentNodeToEnqueuedStylesheetConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [
ContentNodeToEnqueuedStylesheetConnectionEdge
],
"nodes": [EnqueuedStylesheet],
"pageInfo": ContentNodeToEnqueuedStylesheetConnectionPageInfo
}
ContentNodeToEnqueuedStylesheetConnectionEdge
Description
An edge in a connection
Fields
| Field Name | Description |
|---|---|
cursor - String
|
A cursor for use in pagination |
node - EnqueuedStylesheet!
|
The item at the end of the edge |
Example
{
"cursor": "xyz789",
"node": EnqueuedStylesheet
}
ContentNodeToEnqueuedStylesheetConnectionPageInfo
Description
Page Info on the "ContentNodeToEnqueuedStylesheetConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "abc123",
"hasNextPage": true,
"hasPreviousPage": false,
"startCursor": "abc123"
}
ContentTemplate
Description
The template assigned to a node of content
Fields
| Field Name | Description |
|---|---|
templateName - String
|
The name of the template |
Possible Types
| ContentTemplate Types |
|---|
Example
{"templateName": "xyz789"}
ContentType
Description
An Post Type object
Fields
| Field Name | Description |
|---|---|
canExport - Boolean
|
Whether this content type should can be exported. |
connectedTaxonomies - ContentTypeToTaxonomyConnection
|
Connection between the ContentType type and the Taxonomy type |
Arguments
|
|
contentNodes - ContentTypeToContentNodeConnection
|
Connection between the ContentType type and the ContentNode type |
Arguments
|
|
deleteWithUser - Boolean
|
Whether content of this type should be deleted when the author of it is deleted from the system. |
description - String
|
Description of the content type. |
excludeFromSearch - Boolean
|
Whether to exclude nodes of this content type from front end search results. |
graphqlPluralName - String
|
The plural name of the content type within the GraphQL Schema. |
graphqlSingleName - String
|
The singular name of the content type within the GraphQL Schema. |
hasArchive - Boolean
|
Whether this content type should have archives. Content archives are generated by type and by date. |
hierarchical - Boolean
|
Whether the content type is hierarchical, for example pages. |
id - ID!
|
The globally unique identifier of the post-type object. |
isComment - Boolean!
|
Whether the node is a Comment |
isContentNode - Boolean!
|
Whether the node is a Content Node |
isFrontPage - Boolean!
|
Whether this page is set to the static front page. |
isPostsPage - Boolean!
|
Whether this page is set to the blog posts page. |
isRestricted - Boolean
|
Whether the object is restricted from the current viewer |
isTermNode - Boolean!
|
Whether the node is a Term |
label - String
|
Display name of the content type. |
labels - PostTypeLabelDetails
|
Details about the content type labels. |
menuIcon - String
|
The name of the icon file to display as a menu icon. |
menuPosition - Int
|
The position of this post type in the menu. Only applies if show_in_menu is true. |
name - String
|
The internal name of the post type. This should not be used for display purposes. |
public - Boolean
|
Whether a content type is intended for use publicly either via the admin interface or by front-end users. While the default settings of exclude_from_search, publicly_queryable, show_ui, and show_in_nav_menus are inherited from public, each does not rely on this relationship and controls a very specific intention. |
publiclyQueryable - Boolean
|
Whether queries can be performed on the front end for the content type as part of parse_request(). |
restBase - String
|
Name of content type to display in REST API "wp/v2" namespace. |
restControllerClass - String
|
The REST Controller class assigned to handling this content type. |
showInAdminBar - Boolean
|
Makes this content type available via the admin bar. |
showInGraphql - Boolean
|
Whether to add the content type to the GraphQL Schema. |
showInMenu - Boolean
|
Where to show the content type in the admin menu. To work, $show_ui must be true. If true, the post type is shown in its own top level menu. If false, no menu is shown. If a string of an existing top level menu (eg. "tools.php" or "edit.php?post_type=page"), the post type will be placed as a sub-menu of that. |
showInNavMenus - Boolean
|
Makes this content type available for selection in navigation menus. |
showInRest - Boolean
|
Whether the content type is associated with a route under the the REST API "wp/v2" namespace. |
showUi - Boolean
|
Whether to generate and allow a UI for managing this content type in the admin. |
uri - String
|
The unique resource identifier path |
Example
{
"canExport": false,
"connectedTaxonomies": ContentTypeToTaxonomyConnection,
"contentNodes": ContentTypeToContentNodeConnection,
"deleteWithUser": true,
"description": "xyz789",
"excludeFromSearch": false,
"graphqlPluralName": "xyz789",
"graphqlSingleName": "abc123",
"hasArchive": false,
"hierarchical": false,
"id": "4",
"isComment": false,
"isContentNode": false,
"isFrontPage": true,
"isPostsPage": true,
"isRestricted": true,
"isTermNode": true,
"label": "abc123",
"labels": PostTypeLabelDetails,
"menuIcon": "abc123",
"menuPosition": 123,
"name": "abc123",
"public": false,
"publiclyQueryable": false,
"restBase": "xyz789",
"restControllerClass": "xyz789",
"showInAdminBar": false,
"showInGraphql": true,
"showInMenu": true,
"showInNavMenus": false,
"showInRest": false,
"showUi": true,
"uri": "abc123"
}
ContentTypeConnection
Description
Connection to ContentType Nodes
Fields
| Field Name | Description |
|---|---|
edges - [ContentTypeConnectionEdge!]!
|
A list of edges (relational context) between RootQuery and connected ContentType Nodes |
nodes - [ContentType!]!
|
A list of connected ContentType Nodes |
pageInfo - ContentTypeConnectionPageInfo!
|
Information about pagination in a connection. |
Possible Types
| ContentTypeConnection Types |
|---|
Example
{
"edges": [ContentTypeConnectionEdge],
"nodes": [ContentType],
"pageInfo": ContentTypeConnectionPageInfo
}
ContentTypeConnectionEdge
Description
Edge between a Node and a connected ContentType
Fields
| Field Name | Description |
|---|---|
cursor - String
|
Opaque reference to the nodes position in the connection. Value can be used with pagination args. |
node - ContentType!
|
The connected ContentType Node |
Possible Types
| ContentTypeConnectionEdge Types |
|---|
Example
{
"cursor": "abc123",
"node": ContentType
}
ContentTypeConnectionPageInfo
Description
Page Info on the connected ContentTypeConnectionEdge
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Possible Types
| ContentTypeConnectionPageInfo Types |
|---|
Example
{
"endCursor": "xyz789",
"hasNextPage": true,
"hasPreviousPage": false,
"startCursor": "abc123"
}
ContentTypeEnum
Description
Allowed Content Types
Values
| Enum Value | Description |
|---|---|
|
|
The Type of Content object |
|
|
The Type of Content object |
|
|
The Type of Content object |
|
|
The Type of Content object |
|
|
The Type of Content object |
|
|
The Type of Content object |
|
|
The Type of Content object |
|
|
The Type of Content object |
Example
"ATTACHMENT"
ContentTypeIdTypeEnum
Description
The Type of Identifier used to fetch a single Content Type node. To be used along with the "id" field. Default is "ID".
Values
| Enum Value | Description |
|---|---|
|
|
The globally unique ID |
|
|
The name of the content type. |
Example
"ID"
ContentTypeToContentNodeConnection
Description
Connection between the ContentType type and the ContentNode type
Fields
| Field Name | Description |
|---|---|
edges - [ContentTypeToContentNodeConnectionEdge!]!
|
Edges for the ContentTypeToContentNodeConnection connection |
nodes - [ContentNode!]!
|
The nodes of the connection, without the edges |
pageInfo - ContentTypeToContentNodeConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [ContentTypeToContentNodeConnectionEdge],
"nodes": [ContentNode],
"pageInfo": ContentTypeToContentNodeConnectionPageInfo
}
ContentTypeToContentNodeConnectionEdge
Description
An edge in a connection
Fields
| Field Name | Description |
|---|---|
cursor - String
|
A cursor for use in pagination |
node - ContentNode!
|
The item at the end of the edge |
Example
{
"cursor": "abc123",
"node": ContentNode
}
ContentTypeToContentNodeConnectionPageInfo
Description
Page Info on the "ContentTypeToContentNodeConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "xyz789",
"hasNextPage": false,
"hasPreviousPage": false,
"startCursor": "xyz789"
}
ContentTypeToContentNodeConnectionWhereArgs
Description
Arguments for filtering the ContentTypeToContentNodeConnection connection
Fields
| Input Field | Description |
|---|---|
contentTypes - [ContentTypeEnum]
|
The Types of content to filter |
dateQuery - DateQueryInput
|
Filter the connection based on dates |
hasPassword - Boolean
|
True for objects with passwords; False for objects without passwords; null for all objects with or without passwords |
id - Int
|
Specific database ID of the object |
in - [ID]
|
Array of IDs for the objects to retrieve |
mimeType - MimeTypeEnum
|
Get objects with a specific mimeType property |
name - String
|
Slug / post_name of the object |
nameIn - [String]
|
Specify objects to retrieve. Use slugs |
notIn - [ID]
|
Specify IDs NOT to retrieve. If this is used in the same query as "in", it will be ignored |
orderby - [PostObjectsConnectionOrderbyInput]
|
What parameter to use to order the objects by. |
parent - ID
|
Use ID to return only children. Use 0 to return only top-level items |
parentIn - [ID]
|
Specify objects whose parent is in an array |
parentNotIn - [ID]
|
Specify posts whose parent is not in an array |
password - String
|
Show posts with a specific password. |
search - String
|
Show Posts based on a keyword search |
stati - [PostStatusEnum]
|
Retrieve posts where post status is in an array. |
status - PostStatusEnum
|
Show posts with a specific status. |
title - String
|
Title of the object |
Example
{
"contentTypes": ["ATTACHMENT"],
"dateQuery": DateQueryInput,
"hasPassword": false,
"id": 987,
"in": ["4"],
"mimeType": "APPLICATION_MSWORD",
"name": "xyz789",
"nameIn": ["xyz789"],
"notIn": ["4"],
"orderby": [PostObjectsConnectionOrderbyInput],
"parent": 4,
"parentIn": ["4"],
"parentNotIn": [4],
"password": "abc123",
"search": "abc123",
"stati": ["ACF_DISABLED"],
"status": "ACF_DISABLED",
"title": "abc123"
}
ContentTypeToTaxonomyConnection
Description
Connection between the ContentType type and the Taxonomy type
Fields
| Field Name | Description |
|---|---|
edges - [ContentTypeToTaxonomyConnectionEdge!]!
|
Edges for the ContentTypeToTaxonomyConnection connection |
nodes - [Taxonomy!]!
|
The nodes of the connection, without the edges |
pageInfo - ContentTypeToTaxonomyConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [ContentTypeToTaxonomyConnectionEdge],
"nodes": [Taxonomy],
"pageInfo": ContentTypeToTaxonomyConnectionPageInfo
}
ContentTypeToTaxonomyConnectionEdge
ContentTypeToTaxonomyConnectionPageInfo
Description
Page Info on the "ContentTypeToTaxonomyConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "xyz789",
"hasNextPage": false,
"hasPreviousPage": true,
"startCursor": "xyz789"
}
ContentTypesOfCategoryEnum
Description
Allowed Content Types of the Category taxonomy.
Values
| Enum Value | Description |
|---|---|
|
|
The Type of Content object |
Example
"POST"
ContentTypesOfPostFormatEnum
Description
Allowed Content Types of the PostFormat taxonomy.
Values
| Enum Value | Description |
|---|---|
|
|
The Type of Content object |
Example
"POST"
ContentTypesOfTagEnum
Description
Allowed Content Types of the Tag taxonomy.
Values
| Enum Value | Description |
|---|---|
|
|
The Type of Content object |
Example
"POST"
CreateCategoryInput
Description
Input for the createCategory mutation.
Fields
| Input Field | Description |
|---|---|
aliasOf - String
|
The slug that the category will be an alias of |
clientMutationId - String
|
This is an ID that can be passed to a mutation by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
description - String
|
The description of the category object |
language - LanguageCodeEnum
|
|
name - String!
|
The name of the category object to mutate |
parentId - ID
|
The ID of the category that should be set as the parent |
slug - String
|
If this argument exists then the slug will be checked to see if it is not an existing valid term. If that check succeeds (it is not a valid term), then it is added and the term id is given. If it fails, then a check is made to whether the taxonomy is hierarchical and the parent argument is not empty. If the second check succeeds, the term will be inserted and the term id will be given. If the slug argument is empty, then it will be calculated from the term name. |
Example
{
"aliasOf": "abc123",
"clientMutationId": "abc123",
"description": "xyz789",
"language": "EN",
"name": "abc123",
"parentId": 4,
"slug": "xyz789"
}
CreateCategoryPayload
Description
The payload for the createCategory mutation.
Fields
| Field Name | Description |
|---|---|
category - Category
|
The created category |
clientMutationId - String
|
If a 'clientMutationId' input is provided to the mutation, it will be returned as output on the mutation. This ID can be used by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
Example
{
"category": Category,
"clientMutationId": "abc123"
}
CreateCollectionInput
Description
Input for the createCollection mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
This is an ID that can be passed to a mutation by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
date - String
|
The date of the object. Preferable to enter as year/month/day (e.g. 01/31/2017) as it will rearrange date as fit if it is not specified. Incomplete dates may have unintended results for example, "2017" as the input will use current date with timestamp 20:17 |
language - LanguageCodeEnum
|
|
menuOrder - Int
|
A field used for ordering posts. This is typically used with nav menu items or for special ordering of hierarchical content types. |
password - String
|
The password used to protect the content of the object |
slug - String
|
The slug of the object |
status - PostStatusEnum
|
The status of the object |
title - String
|
The title of the object |
Example
{
"clientMutationId": "abc123",
"date": "xyz789",
"language": "EN",
"menuOrder": 123,
"password": "abc123",
"slug": "abc123",
"status": "ACF_DISABLED",
"title": "xyz789"
}
CreateCollectionPayload
Description
The payload for the createCollection mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
If a 'clientMutationId' input is provided to the mutation, it will be returned as output on the mutation. This ID can be used by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
collection - Collection
|
The Post object mutation type. |
Example
{
"clientMutationId": "xyz789",
"collection": Collection
}
CreateCommentInput
Description
Input for the createComment mutation.
Fields
| Input Field | Description |
|---|---|
approved - String
|
The approval status of the comment. |
author - String
|
The name of the comment's author. |
authorEmail - String
|
The email of the comment's author. |
authorUrl - String
|
The url of the comment's author. |
clientMutationId - String
|
This is an ID that can be passed to a mutation by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
commentOn - Int
|
The database ID of the post object the comment belongs to. |
content - String
|
Content of the comment. |
date - String
|
The date of the object. Preferable to enter as year/month/day ( e.g. 01/31/2017 ) as it will rearrange date as fit if it is not specified. Incomplete dates may have unintended results for example, "2017" as the input will use current date with timestamp 20:17 |
parent - ID
|
Parent comment ID of current comment. |
status - CommentStatusEnum
|
The approval status of the comment |
type - String
|
Type of comment. |
Example
{
"approved": "xyz789",
"author": "xyz789",
"authorEmail": "xyz789",
"authorUrl": "abc123",
"clientMutationId": "abc123",
"commentOn": 987,
"content": "abc123",
"date": "xyz789",
"parent": "4",
"status": "APPROVE",
"type": "xyz789"
}
CreateCommentPayload
Description
The payload for the createComment mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
If a 'clientMutationId' input is provided to the mutation, it will be returned as output on the mutation. This ID can be used by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
comment - Comment
|
The comment that was created |
success - Boolean
|
Whether the mutation succeeded. If the comment is not approved, the server will not return the comment to a non authenticated user, but a success message can be returned if the create succeeded, and the client can optimistically add the comment to the client cache |
Example
{
"clientMutationId": "abc123",
"comment": Comment,
"success": false
}
CreateContactInput
Description
Input for the createContact mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
This is an ID that can be passed to a mutation by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
date - String
|
The date of the object. Preferable to enter as year/month/day (e.g. 01/31/2017) as it will rearrange date as fit if it is not specified. Incomplete dates may have unintended results for example, "2017" as the input will use current date with timestamp 20:17 |
language - LanguageCodeEnum
|
|
menuOrder - Int
|
A field used for ordering posts. This is typically used with nav menu items or for special ordering of hierarchical content types. |
password - String
|
The password used to protect the content of the object |
slug - String
|
The slug of the object |
status - PostStatusEnum
|
The status of the object |
title - String
|
The title of the object |
Example
{
"clientMutationId": "xyz789",
"date": "xyz789",
"language": "EN",
"menuOrder": 987,
"password": "xyz789",
"slug": "xyz789",
"status": "ACF_DISABLED",
"title": "abc123"
}
CreateContactPayload
Description
The payload for the createContact mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
If a 'clientMutationId' input is provided to the mutation, it will be returned as output on the mutation. This ID can be used by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
contact - Contact
|
The Post object mutation type. |
Example
{
"clientMutationId": "xyz789",
"contact": Contact
}
CreateLandingPageInput
Description
Input for the createLandingPage mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
This is an ID that can be passed to a mutation by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
date - String
|
The date of the object. Preferable to enter as year/month/day (e.g. 01/31/2017) as it will rearrange date as fit if it is not specified. Incomplete dates may have unintended results for example, "2017" as the input will use current date with timestamp 20:17 |
language - LanguageCodeEnum
|
|
menuOrder - Int
|
A field used for ordering posts. This is typically used with nav menu items or for special ordering of hierarchical content types. |
password - String
|
The password used to protect the content of the object |
slug - String
|
The slug of the object |
status - PostStatusEnum
|
The status of the object |
title - String
|
The title of the object |
Example
{
"clientMutationId": "xyz789",
"date": "xyz789",
"language": "EN",
"menuOrder": 987,
"password": "xyz789",
"slug": "xyz789",
"status": "ACF_DISABLED",
"title": "abc123"
}
CreateLandingPagePayload
Description
The payload for the createLandingPage mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
If a 'clientMutationId' input is provided to the mutation, it will be returned as output on the mutation. This ID can be used by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
landingPage - LandingPage
|
The Post object mutation type. |
Example
{
"clientMutationId": "xyz789",
"landingPage": LandingPage
}
CreateMediaItemInput
Description
Input for the createMediaItem mutation.
Fields
| Input Field | Description |
|---|---|
altText - String
|
Alternative text to display when mediaItem is not displayed |
authorId - ID
|
The userId to assign as the author of the mediaItem |
caption - String
|
The caption for the mediaItem |
clientMutationId - String
|
This is an ID that can be passed to a mutation by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
commentStatus - String
|
The comment status for the mediaItem |
date - String
|
The date of the mediaItem |
dateGmt - String
|
The date (in GMT zone) of the mediaItem |
description - String
|
Description of the mediaItem |
filePath - String
|
The file name of the mediaItem |
fileType - MimeTypeEnum
|
The file type of the mediaItem |
language - LanguageCodeEnum
|
|
parentId - ID
|
The ID of the parent object |
pingStatus - String
|
The ping status for the mediaItem |
slug - String
|
The slug of the mediaItem |
status - MediaItemStatusEnum
|
The status of the mediaItem |
title - String
|
The title of the mediaItem |
Example
{
"altText": "xyz789",
"authorId": "4",
"caption": "xyz789",
"clientMutationId": "abc123",
"commentStatus": "abc123",
"date": "abc123",
"dateGmt": "abc123",
"description": "xyz789",
"filePath": "abc123",
"fileType": "APPLICATION_MSWORD",
"language": "EN",
"parentId": 4,
"pingStatus": "xyz789",
"slug": "abc123",
"status": "AUTO_DRAFT",
"title": "abc123"
}
CreateMediaItemPayload
Description
The payload for the createMediaItem mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
If a 'clientMutationId' input is provided to the mutation, it will be returned as output on the mutation. This ID can be used by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
mediaItem - MediaItem
|
The MediaItem object mutation type. |
Example
{
"clientMutationId": "xyz789",
"mediaItem": MediaItem
}
CreatePageInput
Description
Input for the createPage mutation.
Fields
| Input Field | Description |
|---|---|
authorId - ID
|
The userId to assign as the author of the object |
clientMutationId - String
|
This is an ID that can be passed to a mutation by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
content - String
|
The content of the object |
date - String
|
The date of the object. Preferable to enter as year/month/day (e.g. 01/31/2017) as it will rearrange date as fit if it is not specified. Incomplete dates may have unintended results for example, "2017" as the input will use current date with timestamp 20:17 |
language - LanguageCodeEnum
|
|
menuOrder - Int
|
A field used for ordering posts. This is typically used with nav menu items or for special ordering of hierarchical content types. |
parentId - ID
|
The ID of the parent object |
password - String
|
The password used to protect the content of the object |
slug - String
|
The slug of the object |
status - PostStatusEnum
|
The status of the object |
title - String
|
The title of the object |
Example
{
"authorId": 4,
"clientMutationId": "abc123",
"content": "abc123",
"date": "abc123",
"language": "EN",
"menuOrder": 123,
"parentId": 4,
"password": "abc123",
"slug": "xyz789",
"status": "ACF_DISABLED",
"title": "xyz789"
}
CreatePagePayload
Description
The payload for the createPage mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
If a 'clientMutationId' input is provided to the mutation, it will be returned as output on the mutation. This ID can be used by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
page - Page
|
The Post object mutation type. |
Example
{
"clientMutationId": "xyz789",
"page": Page
}
CreatePostFormatInput
Description
Input for the createPostFormat mutation.
Fields
| Input Field | Description |
|---|---|
aliasOf - String
|
The slug that the post_format will be an alias of |
clientMutationId - String
|
This is an ID that can be passed to a mutation by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
description - String
|
The description of the post_format object |
name - String!
|
The name of the post_format object to mutate |
slug - String
|
If this argument exists then the slug will be checked to see if it is not an existing valid term. If that check succeeds (it is not a valid term), then it is added and the term id is given. If it fails, then a check is made to whether the taxonomy is hierarchical and the parent argument is not empty. If the second check succeeds, the term will be inserted and the term id will be given. If the slug argument is empty, then it will be calculated from the term name. |
Example
{
"aliasOf": "xyz789",
"clientMutationId": "xyz789",
"description": "abc123",
"name": "abc123",
"slug": "abc123"
}
CreatePostFormatPayload
Description
The payload for the createPostFormat mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
If a 'clientMutationId' input is provided to the mutation, it will be returned as output on the mutation. This ID can be used by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
postFormat - PostFormat
|
The created post_format |
Example
{
"clientMutationId": "abc123",
"postFormat": PostFormat
}
CreatePostInput
Description
Input for the createPost mutation.
Fields
| Input Field | Description |
|---|---|
authorId - ID
|
The userId to assign as the author of the object |
categories - PostCategoriesInput
|
Set connections between the post and categories |
clientMutationId - String
|
This is an ID that can be passed to a mutation by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
content - String
|
The content of the object |
date - String
|
The date of the object. Preferable to enter as year/month/day (e.g. 01/31/2017) as it will rearrange date as fit if it is not specified. Incomplete dates may have unintended results for example, "2017" as the input will use current date with timestamp 20:17 |
language - LanguageCodeEnum
|
|
menuOrder - Int
|
A field used for ordering posts. This is typically used with nav menu items or for special ordering of hierarchical content types. |
password - String
|
The password used to protect the content of the object |
postFormats - PostPostFormatsInput
|
Set connections between the post and postFormats |
slug - String
|
The slug of the object |
status - PostStatusEnum
|
The status of the object |
tags - PostTagsInput
|
Set connections between the post and tags |
title - String
|
The title of the object |
Example
{
"authorId": "4",
"categories": PostCategoriesInput,
"clientMutationId": "xyz789",
"content": "abc123",
"date": "xyz789",
"language": "EN",
"menuOrder": 987,
"password": "xyz789",
"postFormats": PostPostFormatsInput,
"slug": "abc123",
"status": "ACF_DISABLED",
"tags": PostTagsInput,
"title": "xyz789"
}
CreatePostPayload
Description
The payload for the createPost mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
If a 'clientMutationId' input is provided to the mutation, it will be returned as output on the mutation. This ID can be used by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
post - Post
|
The Post object mutation type. |
Example
{
"clientMutationId": "abc123",
"post": Post
}
CreateReleaseInput
Description
Input for the createRelease mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
This is an ID that can be passed to a mutation by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
content - String
|
The content of the object |
date - String
|
The date of the object. Preferable to enter as year/month/day (e.g. 01/31/2017) as it will rearrange date as fit if it is not specified. Incomplete dates may have unintended results for example, "2017" as the input will use current date with timestamp 20:17 |
language - LanguageCodeEnum
|
|
menuOrder - Int
|
A field used for ordering posts. This is typically used with nav menu items or for special ordering of hierarchical content types. |
password - String
|
The password used to protect the content of the object |
slug - String
|
The slug of the object |
status - PostStatusEnum
|
The status of the object |
title - String
|
The title of the object |
Example
{
"clientMutationId": "xyz789",
"content": "xyz789",
"date": "xyz789",
"language": "EN",
"menuOrder": 987,
"password": "xyz789",
"slug": "abc123",
"status": "ACF_DISABLED",
"title": "xyz789"
}
CreateReleasePayload
Description
The payload for the createRelease mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
If a 'clientMutationId' input is provided to the mutation, it will be returned as output on the mutation. This ID can be used by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
release - Release
|
The Post object mutation type. |
Example
{
"clientMutationId": "abc123",
"release": Release
}
CreateTagInput
Description
Input for the createTag mutation.
Fields
| Input Field | Description |
|---|---|
aliasOf - String
|
The slug that the post_tag will be an alias of |
clientMutationId - String
|
This is an ID that can be passed to a mutation by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
description - String
|
The description of the post_tag object |
language - LanguageCodeEnum
|
|
name - String!
|
The name of the post_tag object to mutate |
slug - String
|
If this argument exists then the slug will be checked to see if it is not an existing valid term. If that check succeeds (it is not a valid term), then it is added and the term id is given. If it fails, then a check is made to whether the taxonomy is hierarchical and the parent argument is not empty. If the second check succeeds, the term will be inserted and the term id will be given. If the slug argument is empty, then it will be calculated from the term name. |
Example
{
"aliasOf": "abc123",
"clientMutationId": "abc123",
"description": "abc123",
"language": "EN",
"name": "xyz789",
"slug": "abc123"
}
CreateTagPayload
Description
The payload for the createTag mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
If a 'clientMutationId' input is provided to the mutation, it will be returned as output on the mutation. This ID can be used by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
tag - Tag
|
The created post_tag |
Example
{
"clientMutationId": "xyz789",
"tag": Tag
}
CreateTranslationInput
Description
Input for the createTranslation mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
This is an ID that can be passed to a mutation by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
date - String
|
The date of the object. Preferable to enter as year/month/day (e.g. 01/31/2017) as it will rearrange date as fit if it is not specified. Incomplete dates may have unintended results for example, "2017" as the input will use current date with timestamp 20:17 |
menuOrder - Int
|
A field used for ordering posts. This is typically used with nav menu items or for special ordering of hierarchical content types. |
password - String
|
The password used to protect the content of the object |
slug - String
|
The slug of the object |
status - PostStatusEnum
|
The status of the object |
title - String
|
The title of the object |
Example
{
"clientMutationId": "abc123",
"date": "abc123",
"menuOrder": 123,
"password": "xyz789",
"slug": "abc123",
"status": "ACF_DISABLED",
"title": "abc123"
}
CreateTranslationPayload
Description
The payload for the createTranslation mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
If a 'clientMutationId' input is provided to the mutation, it will be returned as output on the mutation. This ID can be used by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
translation - Translation
|
The Post object mutation type. |
Example
{
"clientMutationId": "xyz789",
"translation": Translation
}
CreateUserInput
Description
Input for the createUser mutation.
Fields
| Input Field | Description |
|---|---|
aim - String
|
User's AOL IM account. |
clientMutationId - String
|
This is an ID that can be passed to a mutation by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
description - String
|
A string containing content about the user. |
displayName - String
|
A string that will be shown on the site. Defaults to user's username. It is likely that you will want to change this, for both appearance and security through obscurity (that is if you dont use and delete the default admin user). |
email - String
|
A string containing the user's email address. |
firstName - String
|
|
jabber - String
|
User's Jabber account. |
lastName - String
|
The user's last name. |
locale - String
|
User's locale. |
nicename - String
|
A string that contains a URL-friendly name for the user. The default is the user's username. |
nickname - String
|
The user's nickname, defaults to the user's username. |
password - String
|
A string that contains the plain text password for the user. |
registered - String
|
The date the user registered. Format is Y-m-d H:i:s. |
richEditing - String
|
A string for whether to enable the rich editor or not. False if not empty. |
roles - [String]
|
An array of roles to be assigned to the user. |
username - String!
|
A string that contains the user's username for logging in. |
websiteUrl - String
|
A string containing the user's URL for the user's web site. |
yim - String
|
User's Yahoo IM account. |
Example
{
"aim": "xyz789",
"clientMutationId": "abc123",
"description": "abc123",
"displayName": "xyz789",
"email": "xyz789",
"firstName": "abc123",
"jabber": "abc123",
"lastName": "xyz789",
"locale": "abc123",
"nicename": "abc123",
"nickname": "abc123",
"password": "xyz789",
"registered": "xyz789",
"richEditing": "xyz789",
"roles": ["abc123"],
"username": "abc123",
"websiteUrl": "abc123",
"yim": "xyz789"
}
CreateUserPayload
Description
The payload for the createUser mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
If a 'clientMutationId' input is provided to the mutation, it will be returned as output on the mutation. This ID can be used by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
user - User
|
The User object mutation type. |
Example
{
"clientMutationId": "abc123",
"user": User
}
DatabaseIdentifier
Description
Object that can be identified with a Database ID
Fields
| Field Name | Description |
|---|---|
databaseId - Int!
|
The unique identifier stored in the database |
Possible Types
| DatabaseIdentifier Types |
|---|
Example
{"databaseId": 123}
DateInput
DateQueryInput
Description
Filter the connection based on input
Fields
| Input Field | Description |
|---|---|
after - DateInput
|
Nodes should be returned after this date |
before - DateInput
|
Nodes should be returned before this date |
column - PostObjectsConnectionDateColumnEnum
|
Column to query against |
compare - String
|
For after/before, whether exact value should be matched or not |
day - Int
|
Day of the month (from 1 to 31) |
hour - Int
|
Hour (from 0 to 23) |
inclusive - Boolean
|
For after/before, whether exact value should be matched or not |
minute - Int
|
Minute (from 0 to 59) |
month - Int
|
Month number (from 1 to 12) |
relation - RelationEnum
|
OR or AND, how the sub-arrays should be compared |
second - Int
|
Second (0 to 59) |
week - Int
|
Week of the year (from 0 to 53) |
year - Int
|
4 digit year (e.g. 2017) |
Example
{
"after": DateInput,
"before": DateInput,
"column": "DATE",
"compare": "abc123",
"day": 987,
"hour": 987,
"inclusive": true,
"minute": 123,
"month": 987,
"relation": "AND",
"second": 123,
"week": 987,
"year": 987
}
DefaultImages
Description
Default images of different post types. Returns url of image of queried post type. Values come from Sivuston Asetukset -> Oletuskuvat.
Example
{
"article": "xyz789",
"event": "xyz789",
"hero": "abc123",
"page": "xyz789"
}
DefaultTemplate
Description
The template assigned to the node
Fields
| Field Name | Description |
|---|---|
templateName - String
|
The name of the template |
Example
{"templateName": "abc123"}
DeleteCategoryInput
Description
Input for the deleteCategory mutation.
Example
{
"clientMutationId": "abc123",
"id": "4"
}
DeleteCategoryPayload
Description
The payload for the deleteCategory mutation.
Fields
| Field Name | Description |
|---|---|
category - Category
|
The deleted term object |
clientMutationId - String
|
If a 'clientMutationId' input is provided to the mutation, it will be returned as output on the mutation. This ID can be used by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
deletedId - ID
|
The ID of the deleted object |
Example
{
"category": Category,
"clientMutationId": "abc123",
"deletedId": "4"
}
DeleteCollectionInput
Description
Input for the deleteCollection mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
This is an ID that can be passed to a mutation by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
forceDelete - Boolean
|
Whether the object should be force deleted instead of being moved to the trash |
id - ID!
|
The ID of the collection to delete |
ignoreEditLock - Boolean
|
Override the edit lock when another user is editing the post |
Example
{
"clientMutationId": "xyz789",
"forceDelete": false,
"id": "4",
"ignoreEditLock": true
}
DeleteCollectionPayload
Description
The payload for the deleteCollection mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
If a 'clientMutationId' input is provided to the mutation, it will be returned as output on the mutation. This ID can be used by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
collection - Collection
|
The object before it was deleted |
deletedId - ID
|
The ID of the deleted object |
Example
{
"clientMutationId": "abc123",
"collection": Collection,
"deletedId": "4"
}
DeleteCommentInput
Description
Input for the deleteComment mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
This is an ID that can be passed to a mutation by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
forceDelete - Boolean
|
Whether the comment should be force deleted instead of being moved to the trash |
id - ID!
|
The deleted comment ID |
Example
{
"clientMutationId": "xyz789",
"forceDelete": false,
"id": "4"
}
DeleteCommentPayload
Description
The payload for the deleteComment mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
If a 'clientMutationId' input is provided to the mutation, it will be returned as output on the mutation. This ID can be used by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
comment - Comment
|
The deleted comment object |
deletedId - ID
|
The deleted comment ID |
Example
{
"clientMutationId": "abc123",
"comment": Comment,
"deletedId": "4"
}
DeleteContactInput
Description
Input for the deleteContact mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
This is an ID that can be passed to a mutation by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
forceDelete - Boolean
|
Whether the object should be force deleted instead of being moved to the trash |
id - ID!
|
The ID of the contact to delete |
ignoreEditLock - Boolean
|
Override the edit lock when another user is editing the post |
Example
{
"clientMutationId": "abc123",
"forceDelete": false,
"id": 4,
"ignoreEditLock": true
}
DeleteContactPayload
Description
The payload for the deleteContact mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
If a 'clientMutationId' input is provided to the mutation, it will be returned as output on the mutation. This ID can be used by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
contact - Contact
|
The object before it was deleted |
deletedId - ID
|
The ID of the deleted object |
Example
{
"clientMutationId": "xyz789",
"contact": Contact,
"deletedId": "4"
}
DeleteLandingPageInput
Description
Input for the deleteLandingPage mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
This is an ID that can be passed to a mutation by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
forceDelete - Boolean
|
Whether the object should be force deleted instead of being moved to the trash |
id - ID!
|
The ID of the landingPage to delete |
ignoreEditLock - Boolean
|
Override the edit lock when another user is editing the post |
Example
{
"clientMutationId": "xyz789",
"forceDelete": true,
"id": 4,
"ignoreEditLock": true
}
DeleteLandingPagePayload
Description
The payload for the deleteLandingPage mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
If a 'clientMutationId' input is provided to the mutation, it will be returned as output on the mutation. This ID can be used by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
deletedId - ID
|
The ID of the deleted object |
landingPage - LandingPage
|
The object before it was deleted |
Example
{
"clientMutationId": "xyz789",
"deletedId": 4,
"landingPage": LandingPage
}
DeleteMediaItemInput
Description
Input for the deleteMediaItem mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
This is an ID that can be passed to a mutation by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
forceDelete - Boolean
|
Whether the mediaItem should be force deleted instead of being moved to the trash |
id - ID!
|
The ID of the mediaItem to delete |
Example
{
"clientMutationId": "abc123",
"forceDelete": false,
"id": "4"
}
DeleteMediaItemPayload
Description
The payload for the deleteMediaItem mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
If a 'clientMutationId' input is provided to the mutation, it will be returned as output on the mutation. This ID can be used by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
deletedId - ID
|
The ID of the deleted mediaItem |
mediaItem - MediaItem
|
The mediaItem before it was deleted |
Example
{
"clientMutationId": "abc123",
"deletedId": 4,
"mediaItem": MediaItem
}
DeletePageInput
Description
Input for the deletePage mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
This is an ID that can be passed to a mutation by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
forceDelete - Boolean
|
Whether the object should be force deleted instead of being moved to the trash |
id - ID!
|
The ID of the page to delete |
ignoreEditLock - Boolean
|
Override the edit lock when another user is editing the post |
Example
{
"clientMutationId": "abc123",
"forceDelete": false,
"id": "4",
"ignoreEditLock": true
}
DeletePagePayload
Description
The payload for the deletePage mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
If a 'clientMutationId' input is provided to the mutation, it will be returned as output on the mutation. This ID can be used by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
deletedId - ID
|
The ID of the deleted object |
page - Page
|
The object before it was deleted |
Example
{
"clientMutationId": "xyz789",
"deletedId": 4,
"page": Page
}
DeletePostFormatInput
Description
Input for the deletePostFormat mutation.
Example
{
"clientMutationId": "abc123",
"id": "4"
}
DeletePostFormatPayload
Description
The payload for the deletePostFormat mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
If a 'clientMutationId' input is provided to the mutation, it will be returned as output on the mutation. This ID can be used by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
deletedId - ID
|
The ID of the deleted object |
postFormat - PostFormat
|
The deleted term object |
Example
{
"clientMutationId": "abc123",
"deletedId": "4",
"postFormat": PostFormat
}
DeletePostInput
Description
Input for the deletePost mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
This is an ID that can be passed to a mutation by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
forceDelete - Boolean
|
Whether the object should be force deleted instead of being moved to the trash |
id - ID!
|
The ID of the post to delete |
ignoreEditLock - Boolean
|
Override the edit lock when another user is editing the post |
Example
{
"clientMutationId": "abc123",
"forceDelete": false,
"id": "4",
"ignoreEditLock": false
}
DeletePostPayload
Description
The payload for the deletePost mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
If a 'clientMutationId' input is provided to the mutation, it will be returned as output on the mutation. This ID can be used by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
deletedId - ID
|
The ID of the deleted object |
post - Post
|
The object before it was deleted |
Example
{
"clientMutationId": "abc123",
"deletedId": "4",
"post": Post
}
DeleteReleaseInput
Description
Input for the deleteRelease mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
This is an ID that can be passed to a mutation by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
forceDelete - Boolean
|
Whether the object should be force deleted instead of being moved to the trash |
id - ID!
|
The ID of the release to delete |
ignoreEditLock - Boolean
|
Override the edit lock when another user is editing the post |
Example
{
"clientMutationId": "xyz789",
"forceDelete": true,
"id": "4",
"ignoreEditLock": true
}
DeleteReleasePayload
Description
The payload for the deleteRelease mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
If a 'clientMutationId' input is provided to the mutation, it will be returned as output on the mutation. This ID can be used by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
deletedId - ID
|
The ID of the deleted object |
release - Release
|
The object before it was deleted |
Example
{
"clientMutationId": "xyz789",
"deletedId": "4",
"release": Release
}
DeleteTagInput
Description
Input for the deleteTag mutation.
Example
{"clientMutationId": "abc123", "id": 4}
DeleteTagPayload
Description
The payload for the deleteTag mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
If a 'clientMutationId' input is provided to the mutation, it will be returned as output on the mutation. This ID can be used by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
deletedId - ID
|
The ID of the deleted object |
tag - Tag
|
The deleted term object |
Example
{
"clientMutationId": "xyz789",
"deletedId": "4",
"tag": Tag
}
DeleteTranslationInput
Description
Input for the deleteTranslation mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
This is an ID that can be passed to a mutation by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
forceDelete - Boolean
|
Whether the object should be force deleted instead of being moved to the trash |
id - ID!
|
The ID of the translation to delete |
ignoreEditLock - Boolean
|
Override the edit lock when another user is editing the post |
Example
{
"clientMutationId": "xyz789",
"forceDelete": false,
"id": 4,
"ignoreEditLock": false
}
DeleteTranslationPayload
Description
The payload for the deleteTranslation mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
If a 'clientMutationId' input is provided to the mutation, it will be returned as output on the mutation. This ID can be used by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
deletedId - ID
|
The ID of the deleted object |
translation - Translation
|
The object before it was deleted |
Example
{
"clientMutationId": "xyz789",
"deletedId": "4",
"translation": Translation
}
DeleteUserInput
Description
Input for the deleteUser mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
This is an ID that can be passed to a mutation by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
id - ID!
|
The ID of the user you want to delete |
reassignId - ID
|
Reassign posts and links to new User ID. |
Example
{
"clientMutationId": "xyz789",
"id": "4",
"reassignId": "4"
}
DeleteUserPayload
Description
The payload for the deleteUser mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
If a 'clientMutationId' input is provided to the mutation, it will be returned as output on the mutation. This ID can be used by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
deletedId - ID
|
The ID of the user that you just deleted |
user - User
|
The deleted user object |
Example
{
"clientMutationId": "xyz789",
"deletedId": 4,
"user": User
}
DiscussionSettings
Description
The discussion setting type
Example
{
"defaultCommentStatus": "xyz789",
"defaultPingStatus": "xyz789"
}
Edge
Description
Relational context between connected nodes
Fields
| Field Name | Description |
|---|---|
cursor - String
|
Opaque reference to the nodes position in the connection. Value can be used with pagination args. |
node - Node!
|
The connected node |
Possible Types
| Edge Types |
|---|
Example
{
"cursor": "xyz789",
"node": Node
}
EnqueuedAsset
Description
Asset enqueued by the CMS
Fields
| Field Name | Description |
|---|---|
after - [String]
|
The inline code to be run after the asset is loaded. |
args - Boolean
|
Deprecated Use EnqueuedAsset.media instead.
|
before - [String]
|
The inline code to be run before the asset is loaded. |
conditional - String
|
The HTML conditional comment for the enqueued asset. E.g. IE 6, lte IE 7, etc |
dependencies - [EnqueuedAsset]
|
Dependencies needed to use this asset |
extra - String
|
Extra information needed for the script Use EnqueuedScript.extraData instead.
|
handle - String
|
The handle of the enqueued asset |
id - ID!
|
The ID of the enqueued asset |
src - String
|
The source of the asset |
version - String
|
The version of the enqueued asset |
Possible Types
| EnqueuedAsset Types |
|---|
Example
{
"after": ["abc123"],
"args": true,
"before": ["xyz789"],
"conditional": "xyz789",
"dependencies": [EnqueuedAsset],
"extra": "abc123",
"handle": "abc123",
"id": "4",
"src": "xyz789",
"version": "xyz789"
}
EnqueuedScript
Description
Script enqueued by the CMS
Fields
| Field Name | Description |
|---|---|
after - [String]
|
The inline code to be run after the asset is loaded. |
args - Boolean
|
Deprecated Use EnqueuedAsset.media instead.
|
before - [String]
|
The inline code to be run before the asset is loaded. |
conditional - String
|
The HTML conditional comment for the enqueued asset. E.g. IE 6, lte IE 7, etc |
dependencies - [EnqueuedScript]
|
Dependencies needed to use this asset |
extra - String
|
Extra information needed for the script Use EnqueuedScript.extraData instead.
|
extraData - String
|
Extra data supplied to the enqueued script |
handle - String
|
The handle of the enqueued asset |
id - ID!
|
The global ID of the enqueued script |
src - String
|
The source of the asset |
strategy - ScriptLoadingStrategyEnum
|
The loading strategy to use on the script tag |
version - String
|
The version of the enqueued script |
Example
{
"after": ["abc123"],
"args": true,
"before": ["xyz789"],
"conditional": "xyz789",
"dependencies": [EnqueuedScript],
"extra": "xyz789",
"extraData": "xyz789",
"handle": "abc123",
"id": "4",
"src": "xyz789",
"strategy": "ASYNC",
"version": "xyz789"
}
EnqueuedScriptConnection
Description
Connection to EnqueuedScript Nodes
Fields
| Field Name | Description |
|---|---|
edges - [EnqueuedScriptConnectionEdge!]!
|
A list of edges (relational context) between ContentNode and connected EnqueuedScript Nodes |
nodes - [EnqueuedScript!]!
|
A list of connected EnqueuedScript Nodes |
pageInfo - EnqueuedScriptConnectionPageInfo!
|
Information about pagination in a connection. |
Possible Types
| EnqueuedScriptConnection Types |
|---|
Example
{
"edges": [EnqueuedScriptConnectionEdge],
"nodes": [EnqueuedScript],
"pageInfo": EnqueuedScriptConnectionPageInfo
}
EnqueuedScriptConnectionEdge
Description
Edge between a Node and a connected EnqueuedScript
Fields
| Field Name | Description |
|---|---|
cursor - String
|
Opaque reference to the nodes position in the connection. Value can be used with pagination args. |
node - EnqueuedScript!
|
The connected EnqueuedScript Node |
Possible Types
| EnqueuedScriptConnectionEdge Types |
|---|
Example
{
"cursor": "xyz789",
"node": EnqueuedScript
}
EnqueuedScriptConnectionPageInfo
Description
Page Info on the connected EnqueuedScriptConnectionEdge
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Possible Types
| EnqueuedScriptConnectionPageInfo Types |
|---|
Example
{
"endCursor": "xyz789",
"hasNextPage": true,
"hasPreviousPage": false,
"startCursor": "abc123"
}
EnqueuedStylesheet
Description
Stylesheet enqueued by the CMS
Fields
| Field Name | Description |
|---|---|
after - [String]
|
The inline code to be run after the asset is loaded. |
args - Boolean
|
Deprecated Use EnqueuedAsset.media instead.
|
before - [String]
|
The inline code to be run before the asset is loaded. |
conditional - String
|
The HTML conditional comment for the enqueued asset. E.g. IE 6, lte IE 7, etc |
dependencies - [EnqueuedStylesheet]
|
Dependencies needed to use this asset |
extra - String
|
Extra information needed for the script Use EnqueuedScript.extraData instead.
|
handle - String
|
The handle of the enqueued asset |
id - ID!
|
The global ID of the enqueued stylesheet |
isRtl - Boolean
|
Whether the enqueued style is RTL or not |
media - String
|
The media attribute to use for the link |
path - String
|
The absolute path to the enqueued style. Set when the stylesheet is meant to load inline. |
rel - String
|
The rel attribute to use for the link |
src - String
|
The source of the asset |
suffix - String
|
Optional suffix, used in combination with RTL |
title - String
|
The title of the enqueued style. Used for preferred/alternate stylesheets. |
version - String
|
The version of the enqueued style |
Example
{
"after": ["abc123"],
"args": false,
"before": ["xyz789"],
"conditional": "xyz789",
"dependencies": [EnqueuedStylesheet],
"extra": "abc123",
"handle": "abc123",
"id": 4,
"isRtl": true,
"media": "xyz789",
"path": "abc123",
"rel": "xyz789",
"src": "abc123",
"suffix": "abc123",
"title": "xyz789",
"version": "abc123"
}
EnqueuedStylesheetConnection
Description
Connection to EnqueuedStylesheet Nodes
Fields
| Field Name | Description |
|---|---|
edges - [EnqueuedStylesheetConnectionEdge!]!
|
A list of edges (relational context) between ContentNode and connected EnqueuedStylesheet Nodes |
nodes - [EnqueuedStylesheet!]!
|
A list of connected EnqueuedStylesheet Nodes |
pageInfo - EnqueuedStylesheetConnectionPageInfo!
|
Information about pagination in a connection. |
Possible Types
| EnqueuedStylesheetConnection Types |
|---|
Example
{
"edges": [EnqueuedStylesheetConnectionEdge],
"nodes": [EnqueuedStylesheet],
"pageInfo": EnqueuedStylesheetConnectionPageInfo
}
EnqueuedStylesheetConnectionEdge
Description
Edge between a Node and a connected EnqueuedStylesheet
Fields
| Field Name | Description |
|---|---|
cursor - String
|
Opaque reference to the nodes position in the connection. Value can be used with pagination args. |
node - EnqueuedStylesheet!
|
The connected EnqueuedStylesheet Node |
Possible Types
| EnqueuedStylesheetConnectionEdge Types |
|---|
Example
{
"cursor": "abc123",
"node": EnqueuedStylesheet
}
EnqueuedStylesheetConnectionPageInfo
Description
Page Info on the connected EnqueuedStylesheetConnectionEdge
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Possible Types
| EnqueuedStylesheetConnectionPageInfo Types |
|---|
Example
{
"endCursor": "abc123",
"hasNextPage": true,
"hasPreviousPage": false,
"startCursor": "xyz789"
}
EventSearch
Description
Collection Module: EventSearch
Fields
| Field Name | Description |
|---|---|
initAmountOfEvents - Int
|
Amount of events listed before "show more -button" |
module - String
|
Module type |
modules - [CollectionModulesUnionType]
|
List of modules |
showAllLink - String
|
Show all -link, final link is combination of Tapahtuma- ja kurssikarusellin hakutulosten osoite -link and search params of the module, for example: https://client-url.com/search/?sort=end_time&super_event_type=umbrella,none&language=fi&start=2022-10-29 |
showAllLinkCustom - String
|
Show all -link |
title - String
|
Module title |
url - String
|
Search query |
Example
{
"initAmountOfEvents": 123,
"module": "abc123",
"modules": [EventSearch],
"showAllLink": "abc123",
"showAllLinkCustom": "xyz789",
"title": "abc123",
"url": "abc123"
}
EventSearchCarousel
Description
Collection Module: EventSearchCarousel
Fields
| Field Name | Description |
|---|---|
amountOfCards - Int
|
Amount of cards in carousel |
eventsNearby - Boolean
|
Events nearby |
module - String
|
Module type |
modules - [CollectionModulesUnionType]
|
List of modules |
orderNewestFirst - Boolean
|
Events order |
showAllLink - String
|
Show all -link, final link is combination of Tapahtuma- ja kurssikarusellin hakutulosten osoite -link and search params of the module, for example: https://client-url.com/search/?sort=end_time&super_event_type=umbrella,none&language=fi&start=2022-10-29 |
showAllLinkCustom - String
|
Show all -link |
title - String
|
Module title |
url - String
|
Search query |
Example
{
"amountOfCards": 123,
"eventsNearby": true,
"module": "xyz789",
"modules": [EventSearch],
"orderNewestFirst": true,
"showAllLink": "abc123",
"showAllLinkCustom": "xyz789",
"title": "abc123",
"url": "abc123"
}
EventSelected
Description
Collection Module: EventSelected
Example
{
"events": ["abc123"],
"initAmountOfEvents": 987,
"module": "abc123",
"modules": [EventSearch],
"showAllLink": "abc123",
"title": "xyz789"
}
EventSelectedCarousel
Description
Collection Module: EventSelectedCarousel
Fields
| Field Name | Description |
|---|---|
amountOfCards - Int
|
Amount of cards in carousel |
amountOfCardsPerRow - Int
|
Amount of cards per row |
events - [String]
|
List of event IDs |
eventsNearby - Boolean
|
Events nearby |
module - String
|
Module type |
modules - [CollectionModulesUnionType]
|
List of modules |
showAllLink - String
|
Show all -link |
title - String
|
Module title |
Example
{
"amountOfCards": 987,
"amountOfCardsPerRow": 123,
"events": ["abc123"],
"eventsNearby": false,
"module": "abc123",
"modules": [EventSearch],
"showAllLink": "xyz789",
"title": "xyz789"
}
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
987.65
GalleryImage
Description
Gallery Image
Fields
| Field Name | Description |
|---|---|
caption - String
|
Caption of the image |
description - String
|
Description of the image |
large - String
|
The url of the large image |
medium - String
|
The url of the medium image |
medium_large - String
|
The url of the medium large image |
thumbnail - String
|
The url of the thumbnail image |
title - String
|
Title of the image |
Example
{
"caption": "xyz789",
"description": "xyz789",
"large": "abc123",
"medium": "abc123",
"medium_large": "xyz789",
"thumbnail": "abc123",
"title": "xyz789"
}
GeneralSettings
Description
The general setting type
Fields
| Field Name | Description |
|---|---|
dateFormat - String
|
Muoto kaikille päivämäärän merkkijonoille. |
description - String
|
Sivuston kuvaus. |
language - String
|
WordPressin kieli- ja maakoodi. |
startOfWeek - Int
|
Viikonpäivän numero josta viikko alkaa. |
timeFormat - String
|
Muoto kaikille kellonajan merkkijonoille. |
timezone - String
|
Kaupunki samalla aikavyöhykkeellä kuin sinä. |
title - String
|
Sivuston otsikko. |
url - String
|
Site URL. |
Example
{
"dateFormat": "abc123",
"description": "abc123",
"language": "xyz789",
"startOfWeek": 987,
"timeFormat": "xyz789",
"timezone": "abc123",
"title": "abc123",
"url": "xyz789"
}
Hero
Description
Hero field
Fields
| Field Name | Description |
|---|---|
background_color - String
|
The background color of the hero |
background_image_url - String
|
The background color of the hero |
description - String
|
The desctiption of the hero |
link - Link
|
The title of the hero link |
title - String
|
The title of the hero |
wave_motif - String
|
The wave motif of the hero |
Example
{
"background_color": "xyz789",
"background_image_url": "abc123",
"description": "xyz789",
"link": Link,
"title": "xyz789",
"wave_motif": "xyz789"
}
HierarchicalContentNode
Description
Content node with hierarchical (parent/child) relationships
Fields
| Field Name | Description |
|---|---|
ancestors - HierarchicalContentNodeToContentNodeAncestorsConnection
|
Returns ancestors of the node. Default ordered as lowest (closest to the child) to highest (closest to the root). |
Arguments
|
|
children - HierarchicalContentNodeToContentNodeChildrenConnection
|
Connection between the HierarchicalContentNode type and the ContentNode type |
Arguments
|
|
contentType - ContentNodeToContentTypeConnectionEdge
|
Connection between the ContentNode type and the ContentType type |
contentTypeName - String!
|
The name of the Content Type the node belongs to |
databaseId - Int!
|
The unique identifier stored in the database |
date - String
|
Post publishing date. |
dateGmt - String
|
The publishing date set in GMT. |
desiredSlug - String
|
The desired slug of the post |
editingLockedBy - ContentNodeToEditLockConnectionEdge
|
If a user has edited the node within the past 15 seconds, this will return the user that last edited. Null if the edit lock doesn't exist or is greater than 15 seconds |
enclosure - String
|
The RSS enclosure for the object |
enqueuedScripts - ContentNodeToEnqueuedScriptConnection
|
Connection between the ContentNode type and the EnqueuedScript type |
Arguments
|
|
enqueuedStylesheets - ContentNodeToEnqueuedStylesheetConnection
|
Connection between the ContentNode type and the EnqueuedStylesheet type |
Arguments
|
|
guid - String
|
The global unique identifier for this post. This currently matches the value stored in WP_Post->guid and the guid column in the "post_objects" database table. |
id - ID!
|
The globally unique ID for the object |
isComment - Boolean!
|
Whether the node is a Comment |
isContentNode - Boolean!
|
Whether the node is a Content Node |
isFrontPage - Boolean!
|
Whether the node represents the front page. |
isPostsPage - Boolean!
|
Whether the node represents the blog page. |
isPreview - Boolean
|
Whether the object is a node in the preview state |
isRestricted - Boolean
|
Whether the object is restricted from the current viewer |
isTermNode - Boolean!
|
Whether the node is a Term |
lastEditedBy - ContentNodeToEditLastConnectionEdge
|
The user that most recently edited the node |
link - String
|
The permalink of the post |
modified - String
|
The local modified time for a post. If a post was recently updated the modified field will change to match the corresponding time. |
modifiedGmt - String
|
The GMT modified time for a post. If a post was recently updated the modified field will change to match the corresponding time in GMT. |
parent - HierarchicalContentNodeToParentContentNodeConnectionEdge
|
The parent of the node. The parent object can be of various types |
parentDatabaseId - Int
|
Database id of the parent node |
parentId - ID
|
The globally unique identifier of the parent node. |
previewRevisionDatabaseId - Int
|
The database id of the preview node |
previewRevisionId - ID
|
Whether the object is a node in the preview state |
slug - String
|
The uri slug for the post. This is equivalent to the WP_Post->post_name field and the post_name column in the database for the "post_objects" table. |
status - String
|
The current status of the object |
template - ContentTemplate
|
The template assigned to a node of content |
uri - String
|
The unique resource identifier path |
Example
{
"ancestors": HierarchicalContentNodeToContentNodeAncestorsConnection,
"children": HierarchicalContentNodeToContentNodeChildrenConnection,
"contentType": ContentNodeToContentTypeConnectionEdge,
"contentTypeName": "xyz789",
"databaseId": 123,
"date": "xyz789",
"dateGmt": "abc123",
"desiredSlug": "xyz789",
"editingLockedBy": ContentNodeToEditLockConnectionEdge,
"enclosure": "abc123",
"enqueuedScripts": ContentNodeToEnqueuedScriptConnection,
"enqueuedStylesheets": ContentNodeToEnqueuedStylesheetConnection,
"guid": "abc123",
"id": "4",
"isComment": false,
"isContentNode": true,
"isFrontPage": false,
"isPostsPage": true,
"isPreview": false,
"isRestricted": true,
"isTermNode": true,
"lastEditedBy": ContentNodeToEditLastConnectionEdge,
"link": "abc123",
"modified": "xyz789",
"modifiedGmt": "abc123",
"parent": HierarchicalContentNodeToParentContentNodeConnectionEdge,
"parentDatabaseId": 123,
"parentId": 4,
"previewRevisionDatabaseId": 987,
"previewRevisionId": 4,
"slug": "xyz789",
"status": "xyz789",
"template": ContentTemplate,
"uri": "abc123"
}
HierarchicalContentNodeToContentNodeAncestorsConnection
Description
Connection between the HierarchicalContentNode type and the ContentNode type
Fields
| Field Name | Description |
|---|---|
edges - [HierarchicalContentNodeToContentNodeAncestorsConnectionEdge!]!
|
Edges for the HierarchicalContentNodeToContentNodeAncestorsConnection connection |
nodes - [ContentNode!]!
|
The nodes of the connection, without the edges |
pageInfo - HierarchicalContentNodeToContentNodeAncestorsConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [
HierarchicalContentNodeToContentNodeAncestorsConnectionEdge
],
"nodes": [ContentNode],
"pageInfo": HierarchicalContentNodeToContentNodeAncestorsConnectionPageInfo
}
HierarchicalContentNodeToContentNodeAncestorsConnectionEdge
Description
An edge in a connection
Fields
| Field Name | Description |
|---|---|
cursor - String
|
A cursor for use in pagination |
node - ContentNode!
|
The item at the end of the edge |
Example
{
"cursor": "abc123",
"node": ContentNode
}
HierarchicalContentNodeToContentNodeAncestorsConnectionPageInfo
Description
Page Info on the "HierarchicalContentNodeToContentNodeAncestorsConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "abc123",
"hasNextPage": false,
"hasPreviousPage": false,
"startCursor": "abc123"
}
HierarchicalContentNodeToContentNodeAncestorsConnectionWhereArgs
Description
Arguments for filtering the HierarchicalContentNodeToContentNodeAncestorsConnection connection
Fields
| Input Field | Description |
|---|---|
contentTypes - [ContentTypeEnum]
|
The Types of content to filter |
dateQuery - DateQueryInput
|
Filter the connection based on dates |
hasPassword - Boolean
|
True for objects with passwords; False for objects without passwords; null for all objects with or without passwords |
id - Int
|
Specific database ID of the object |
in - [ID]
|
Array of IDs for the objects to retrieve |
mimeType - MimeTypeEnum
|
Get objects with a specific mimeType property |
name - String
|
Slug / post_name of the object |
nameIn - [String]
|
Specify objects to retrieve. Use slugs |
notIn - [ID]
|
Specify IDs NOT to retrieve. If this is used in the same query as "in", it will be ignored |
orderby - [PostObjectsConnectionOrderbyInput]
|
What parameter to use to order the objects by. |
parent - ID
|
Use ID to return only children. Use 0 to return only top-level items |
parentIn - [ID]
|
Specify objects whose parent is in an array |
parentNotIn - [ID]
|
Specify posts whose parent is not in an array |
password - String
|
Show posts with a specific password. |
search - String
|
Show Posts based on a keyword search |
stati - [PostStatusEnum]
|
Retrieve posts where post status is in an array. |
status - PostStatusEnum
|
Show posts with a specific status. |
title - String
|
Title of the object |
Example
{
"contentTypes": ["ATTACHMENT"],
"dateQuery": DateQueryInput,
"hasPassword": true,
"id": 123,
"in": ["4"],
"mimeType": "APPLICATION_MSWORD",
"name": "abc123",
"nameIn": ["xyz789"],
"notIn": ["4"],
"orderby": [PostObjectsConnectionOrderbyInput],
"parent": "4",
"parentIn": [4],
"parentNotIn": [4],
"password": "abc123",
"search": "xyz789",
"stati": ["ACF_DISABLED"],
"status": "ACF_DISABLED",
"title": "xyz789"
}
HierarchicalContentNodeToContentNodeChildrenConnection
Description
Connection between the HierarchicalContentNode type and the ContentNode type
Fields
| Field Name | Description |
|---|---|
edges - [HierarchicalContentNodeToContentNodeChildrenConnectionEdge!]!
|
Edges for the HierarchicalContentNodeToContentNodeChildrenConnection connection |
nodes - [ContentNode!]!
|
The nodes of the connection, without the edges |
pageInfo - HierarchicalContentNodeToContentNodeChildrenConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [
HierarchicalContentNodeToContentNodeChildrenConnectionEdge
],
"nodes": [ContentNode],
"pageInfo": HierarchicalContentNodeToContentNodeChildrenConnectionPageInfo
}
HierarchicalContentNodeToContentNodeChildrenConnectionEdge
Description
An edge in a connection
Fields
| Field Name | Description |
|---|---|
cursor - String
|
A cursor for use in pagination |
node - ContentNode!
|
The item at the end of the edge |
Example
{
"cursor": "xyz789",
"node": ContentNode
}
HierarchicalContentNodeToContentNodeChildrenConnectionPageInfo
Description
Page Info on the "HierarchicalContentNodeToContentNodeChildrenConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "xyz789",
"hasNextPage": false,
"hasPreviousPage": true,
"startCursor": "abc123"
}
HierarchicalContentNodeToContentNodeChildrenConnectionWhereArgs
Description
Arguments for filtering the HierarchicalContentNodeToContentNodeChildrenConnection connection
Fields
| Input Field | Description |
|---|---|
contentTypes - [ContentTypeEnum]
|
The Types of content to filter |
dateQuery - DateQueryInput
|
Filter the connection based on dates |
hasPassword - Boolean
|
True for objects with passwords; False for objects without passwords; null for all objects with or without passwords |
id - Int
|
Specific database ID of the object |
in - [ID]
|
Array of IDs for the objects to retrieve |
mimeType - MimeTypeEnum
|
Get objects with a specific mimeType property |
name - String
|
Slug / post_name of the object |
nameIn - [String]
|
Specify objects to retrieve. Use slugs |
notIn - [ID]
|
Specify IDs NOT to retrieve. If this is used in the same query as "in", it will be ignored |
orderby - [PostObjectsConnectionOrderbyInput]
|
What parameter to use to order the objects by. |
parent - ID
|
Use ID to return only children. Use 0 to return only top-level items |
parentIn - [ID]
|
Specify objects whose parent is in an array |
parentNotIn - [ID]
|
Specify posts whose parent is not in an array |
password - String
|
Show posts with a specific password. |
search - String
|
Show Posts based on a keyword search |
stati - [PostStatusEnum]
|
Retrieve posts where post status is in an array. |
status - PostStatusEnum
|
Show posts with a specific status. |
title - String
|
Title of the object |
Example
{
"contentTypes": ["ATTACHMENT"],
"dateQuery": DateQueryInput,
"hasPassword": false,
"id": 987,
"in": ["4"],
"mimeType": "APPLICATION_MSWORD",
"name": "xyz789",
"nameIn": ["abc123"],
"notIn": [4],
"orderby": [PostObjectsConnectionOrderbyInput],
"parent": 4,
"parentIn": ["4"],
"parentNotIn": ["4"],
"password": "xyz789",
"search": "abc123",
"stati": ["ACF_DISABLED"],
"status": "ACF_DISABLED",
"title": "abc123"
}
HierarchicalContentNodeToParentContentNodeConnectionEdge
Description
Connection between the HierarchicalContentNode type and the ContentNode type
Fields
| Field Name | Description |
|---|---|
cursor - String
|
Opaque reference to the nodes position in the connection. Value can be used with pagination args. |
node - ContentNode!
|
The node of the connection, without the edges |
Example
{
"cursor": "abc123",
"node": ContentNode
}
HierarchicalNode
Description
Node with hierarchical (parent/child) relationships
Example
{"databaseId": 987, "id": 4, "parentDatabaseId": 987, "parentId": 4}
HierarchicalTermNode
Description
Term node with hierarchical (parent/child) relationships
Fields
| Field Name | Description |
|---|---|
count - Int
|
The number of objects connected to the object |
databaseId - Int!
|
The unique identifier stored in the database |
description - String
|
The description of the object |
enqueuedScripts - TermNodeToEnqueuedScriptConnection
|
Connection between the TermNode type and the EnqueuedScript type |
Arguments
|
|
enqueuedStylesheets - TermNodeToEnqueuedStylesheetConnection
|
Connection between the TermNode type and the EnqueuedStylesheet type |
Arguments
|
|
id - ID!
|
The globally unique ID for the object |
isComment - Boolean!
|
Whether the node is a Comment |
isContentNode - Boolean!
|
Whether the node is a Content Node |
isFrontPage - Boolean!
|
Whether the node represents the front page. |
isPostsPage - Boolean!
|
Whether the node represents the blog page. |
isRestricted - Boolean
|
Whether the object is restricted from the current viewer |
isTermNode - Boolean!
|
Whether the node is a Term |
link - String
|
The link to the term |
name - String
|
The human friendly name of the object. |
parentDatabaseId - Int
|
Database id of the parent node |
parentId - ID
|
The globally unique identifier of the parent node. |
slug - String
|
An alphanumeric identifier for the object unique to its type. |
taxonomyName - String
|
The name of the taxonomy that the object is associated with |
termGroupId - Int
|
The ID of the term group that this term object belongs to |
termTaxonomyId - Int
|
The taxonomy ID that the object is associated with |
uri - String
|
The unique resource identifier path |
Possible Types
| HierarchicalTermNode Types |
|---|
Example
{
"count": 987,
"databaseId": 987,
"description": "abc123",
"enqueuedScripts": TermNodeToEnqueuedScriptConnection,
"enqueuedStylesheets": TermNodeToEnqueuedStylesheetConnection,
"id": 4,
"isComment": false,
"isContentNode": false,
"isFrontPage": true,
"isPostsPage": true,
"isRestricted": true,
"isTermNode": false,
"link": "xyz789",
"name": "xyz789",
"parentDatabaseId": 123,
"parentId": 4,
"slug": "abc123",
"taxonomyName": "abc123",
"termGroupId": 987,
"termTaxonomyId": 123,
"uri": "xyz789"
}
ID
Description
The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.
Example
4
Image
Description
Image
Fields
| Field Name | Description |
|---|---|
caption - String
|
Caption of the image |
description - String
|
Description of the image |
large - String
|
The url of the large image |
medium - String
|
The url of the medium image |
medium_large - String
|
The url of the medium large image |
thumbnail - String
|
The url of the thumbnail image |
title - String
|
Title of the image |
Example
{
"caption": "abc123",
"description": "abc123",
"large": "abc123",
"medium": "xyz789",
"medium_large": "abc123",
"thumbnail": "abc123",
"title": "abc123"
}
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
123
LandingPage
Description
The landingPage type
Fields
| Field Name | Description |
|---|---|
backgroundColor - String
|
Background Color |
boxColor - String
|
Box Color |
contentType - ContentNodeToContentTypeConnectionEdge
|
Connection between the ContentNode type and the ContentType type |
contentTypeName - String!
|
The name of the Content Type the node belongs to |
databaseId - Int!
|
The unique identifier stored in the database |
date - String
|
Post publishing date. |
dateGmt - String
|
The publishing date set in GMT. |
description - String
|
Description |
desiredSlug - String
|
The desired slug of the post |
desktopImage - LandingPageToMediaItemConnection
|
Desktop Image |
Arguments
|
|
editingLockedBy - ContentNodeToEditLockConnectionEdge
|
If a user has edited the node within the past 15 seconds, this will return the user that last edited. Null if the edit lock doesn't exist or is greater than 15 seconds |
enclosure - String
|
The RSS enclosure for the object |
enqueuedScripts - ContentNodeToEnqueuedScriptConnection
|
Connection between the ContentNode type and the EnqueuedScript type |
Arguments
|
|
enqueuedStylesheets - ContentNodeToEnqueuedStylesheetConnection
|
Connection between the ContentNode type and the EnqueuedStylesheet type |
Arguments
|
|
floatImage - LandingPageToFloatImageConnection
|
Float Image |
Arguments
|
|
guid - String
|
The global unique identifier for this post. This currently matches the value stored in WP_Post->guid and the guid column in the "post_objects" database table. |
heroLink - [String]
|
Link |
id - ID!
|
The globally unique identifier of the landing-page-cpt object. |
isComment - Boolean!
|
Whether the node is a Comment |
isContentNode - Boolean!
|
Whether the node is a Content Node |
isFrontPage - Boolean!
|
Whether the node represents the front page. |
isPostsPage - Boolean!
|
Whether the node represents the blog page. |
isPreview - Boolean
|
Whether the object is a node in the preview state |
isRestricted - Boolean
|
Whether the object is restricted from the current viewer |
isRevision - Boolean
|
True if the node is a revision of another node |
isTermNode - Boolean!
|
Whether the node is a Term |
landingPageId - Int!
|
The id field matches the WP_Post->ID field. Deprecated in favor of the databaseId field |
language - Language
|
Polylang language |
lastEditedBy - ContentNodeToEditLastConnectionEdge
|
The user that most recently edited the node |
link - String
|
The permalink of the post |
mobileImage - LandingPageToMobileImageConnection
|
Mobile Image |
Arguments
|
|
modified - String
|
The local modified time for a post. If a post was recently updated the modified field will change to match the corresponding time. |
modifiedGmt - String
|
The GMT modified time for a post. If a post was recently updated the modified field will change to match the corresponding time in GMT. |
modules - [CollectionModulesUnionType]
|
List of modules |
preview - LandingPageToPreviewConnectionEdge
|
Connection between the LandingPage type and the landingPage type |
previewRevisionDatabaseId - Int
|
The database id of the preview node |
previewRevisionId - ID
|
Whether the object is a node in the preview state |
revisionOf - NodeWithRevisionsToContentNodeConnectionEdge
|
If the current node is a revision, this field exposes the node this is a revision of. Returns null if the node is not a revision of another node. |
revisions - LandingPageToRevisionConnection
|
Connection between the LandingPage type and the landingPage type |
Arguments
|
|
seo - SEO
|
The SEO Framework data of the landingPage |
slug - String
|
The uri slug for the post. This is equivalent to the WP_Post->post_name field and the post_name column in the database for the "post_objects" table. |
status - String
|
The current status of the object |
template - ContentTemplate
|
The template assigned to the node |
title - String
|
The title of the post. This is currently just the raw title. An amendment to support rendered title needs to be made. |
Arguments
|
|
translation - LandingPage
|
Get specific translation version of this object |
Arguments
|
|
translations - [LandingPage]
|
List all translated versions of this post |
uri - String
|
The unique resource identifier path |
Example
{
"backgroundColor": "xyz789",
"boxColor": "abc123",
"contentType": ContentNodeToContentTypeConnectionEdge,
"contentTypeName": "abc123",
"databaseId": 123,
"date": "xyz789",
"dateGmt": "xyz789",
"description": "abc123",
"desiredSlug": "xyz789",
"desktopImage": LandingPageToMediaItemConnection,
"editingLockedBy": ContentNodeToEditLockConnectionEdge,
"enclosure": "xyz789",
"enqueuedScripts": ContentNodeToEnqueuedScriptConnection,
"enqueuedStylesheets": ContentNodeToEnqueuedStylesheetConnection,
"floatImage": LandingPageToFloatImageConnection,
"guid": "xyz789",
"heroLink": ["abc123"],
"id": "4",
"isComment": false,
"isContentNode": true,
"isFrontPage": false,
"isPostsPage": true,
"isPreview": false,
"isRestricted": true,
"isRevision": false,
"isTermNode": false,
"landingPageId": 987,
"language": Language,
"lastEditedBy": ContentNodeToEditLastConnectionEdge,
"link": "xyz789",
"mobileImage": LandingPageToMobileImageConnection,
"modified": "xyz789",
"modifiedGmt": "xyz789",
"modules": [EventSearch],
"preview": LandingPageToPreviewConnectionEdge,
"previewRevisionDatabaseId": 987,
"previewRevisionId": 4,
"revisionOf": NodeWithRevisionsToContentNodeConnectionEdge,
"revisions": LandingPageToRevisionConnection,
"seo": SEO,
"slug": "abc123",
"status": "abc123",
"template": ContentTemplate,
"title": "xyz789",
"translation": LandingPage,
"translations": [LandingPage],
"uri": "abc123"
}
LandingPageConnection
Description
Connection to landingPage Nodes
Fields
| Field Name | Description |
|---|---|
edges - [LandingPageConnectionEdge!]!
|
A list of edges (relational context) between RootQuery and connected landingPage Nodes |
nodes - [LandingPage!]!
|
A list of connected landingPage Nodes |
pageInfo - LandingPageConnectionPageInfo!
|
Information about pagination in a connection. |
Possible Types
| LandingPageConnection Types |
|---|
Example
{
"edges": [LandingPageConnectionEdge],
"nodes": [LandingPage],
"pageInfo": LandingPageConnectionPageInfo
}
LandingPageConnectionEdge
Description
Edge between a Node and a connected landingPage
Fields
| Field Name | Description |
|---|---|
cursor - String
|
Opaque reference to the nodes position in the connection. Value can be used with pagination args. |
node - LandingPage!
|
The connected landingPage Node |
Possible Types
| LandingPageConnectionEdge Types |
|---|
Example
{
"cursor": "abc123",
"node": LandingPage
}
LandingPageConnectionPageInfo
Description
Page Info on the connected LandingPageConnectionEdge
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Possible Types
| LandingPageConnectionPageInfo Types |
|---|
Example
{
"endCursor": "abc123",
"hasNextPage": false,
"hasPreviousPage": true,
"startCursor": "xyz789"
}
LandingPageIdType
Description
The Type of Identifier used to fetch a single resource. Default is ID.
Values
| Enum Value | Description |
|---|---|
|
|
Identify a resource by the Database ID. |
|
|
Identify a resource by the (hashed) Global ID. |
|
|
Identify a resource by the slug. Available to non-hierarchcial Types where the slug is a unique identifier. |
|
|
Identify a resource by the URI. |
Example
"DATABASE_ID"
LandingPageToFloatImageConnection
Description
Connection between the landingPage type and the MediaItem type
Fields
| Field Name | Description |
|---|---|
edges - [LandingPageToFloatImageConnectionEdge!]!
|
Edges for the LandingPageToFloatImageConnection connection |
nodes - [MediaItem!]!
|
The nodes of the connection, without the edges |
pageInfo - LandingPageToFloatImageConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [LandingPageToFloatImageConnectionEdge],
"nodes": [MediaItem],
"pageInfo": LandingPageToFloatImageConnectionPageInfo
}
LandingPageToFloatImageConnectionEdge
Description
An edge in a connection
Fields
| Field Name | Description |
|---|---|
cursor - String
|
A cursor for use in pagination |
node - MediaItem!
|
The item at the end of the edge |
Example
{
"cursor": "xyz789",
"node": MediaItem
}
LandingPageToFloatImageConnectionPageInfo
Description
Page Info on the "LandingPageToFloatImageConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "xyz789",
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "abc123"
}
LandingPageToFloatImageConnectionWhereArgs
Description
Arguments for filtering the LandingPageToFloatImageConnection connection
Fields
| Input Field | Description |
|---|---|
contentTypes - [ContentTypeEnum]
|
The Types of content to filter |
dateQuery - DateQueryInput
|
Filter the connection based on dates |
hasPassword - Boolean
|
True for objects with passwords; False for objects without passwords; null for all objects with or without passwords |
id - Int
|
Specific database ID of the object |
in - [ID]
|
Array of IDs for the objects to retrieve |
mimeType - MimeTypeEnum
|
Get objects with a specific mimeType property |
name - String
|
Slug / post_name of the object |
nameIn - [String]
|
Specify objects to retrieve. Use slugs |
notIn - [ID]
|
Specify IDs NOT to retrieve. If this is used in the same query as "in", it will be ignored |
orderby - [PostObjectsConnectionOrderbyInput]
|
What parameter to use to order the objects by. |
parent - ID
|
Use ID to return only children. Use 0 to return only top-level items |
parentIn - [ID]
|
Specify objects whose parent is in an array |
parentNotIn - [ID]
|
Specify posts whose parent is not in an array |
password - String
|
Show posts with a specific password. |
search - String
|
Show Posts based on a keyword search |
stati - [PostStatusEnum]
|
Retrieve posts where post status is in an array. |
status - PostStatusEnum
|
Show posts with a specific status. |
title - String
|
Title of the object |
Example
{
"contentTypes": ["ATTACHMENT"],
"dateQuery": DateQueryInput,
"hasPassword": true,
"id": 987,
"in": [4],
"mimeType": "APPLICATION_MSWORD",
"name": "xyz789",
"nameIn": ["xyz789"],
"notIn": ["4"],
"orderby": [PostObjectsConnectionOrderbyInput],
"parent": 4,
"parentIn": [4],
"parentNotIn": ["4"],
"password": "abc123",
"search": "abc123",
"stati": ["ACF_DISABLED"],
"status": "ACF_DISABLED",
"title": "abc123"
}
LandingPageToMediaItemConnection
Description
Connection between the landingPage type and the MediaItem type
Fields
| Field Name | Description |
|---|---|
edges - [LandingPageToMediaItemConnectionEdge!]!
|
Edges for the LandingPageToMediaItemConnection connection |
nodes - [MediaItem!]!
|
The nodes of the connection, without the edges |
pageInfo - LandingPageToMediaItemConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [LandingPageToMediaItemConnectionEdge],
"nodes": [MediaItem],
"pageInfo": LandingPageToMediaItemConnectionPageInfo
}
LandingPageToMediaItemConnectionEdge
Description
An edge in a connection
Fields
| Field Name | Description |
|---|---|
cursor - String
|
A cursor for use in pagination |
node - MediaItem!
|
The item at the end of the edge |
Example
{
"cursor": "xyz789",
"node": MediaItem
}
LandingPageToMediaItemConnectionPageInfo
Description
Page Info on the "LandingPageToMediaItemConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "abc123",
"hasNextPage": true,
"hasPreviousPage": false,
"startCursor": "abc123"
}
LandingPageToMediaItemConnectionWhereArgs
Description
Arguments for filtering the LandingPageToMediaItemConnection connection
Fields
| Input Field | Description |
|---|---|
contentTypes - [ContentTypeEnum]
|
The Types of content to filter |
dateQuery - DateQueryInput
|
Filter the connection based on dates |
hasPassword - Boolean
|
True for objects with passwords; False for objects without passwords; null for all objects with or without passwords |
id - Int
|
Specific database ID of the object |
in - [ID]
|
Array of IDs for the objects to retrieve |
mimeType - MimeTypeEnum
|
Get objects with a specific mimeType property |
name - String
|
Slug / post_name of the object |
nameIn - [String]
|
Specify objects to retrieve. Use slugs |
notIn - [ID]
|
Specify IDs NOT to retrieve. If this is used in the same query as "in", it will be ignored |
orderby - [PostObjectsConnectionOrderbyInput]
|
What parameter to use to order the objects by. |
parent - ID
|
Use ID to return only children. Use 0 to return only top-level items |
parentIn - [ID]
|
Specify objects whose parent is in an array |
parentNotIn - [ID]
|
Specify posts whose parent is not in an array |
password - String
|
Show posts with a specific password. |
search - String
|
Show Posts based on a keyword search |
stati - [PostStatusEnum]
|
Retrieve posts where post status is in an array. |
status - PostStatusEnum
|
Show posts with a specific status. |
title - String
|
Title of the object |
Example
{
"contentTypes": ["ATTACHMENT"],
"dateQuery": DateQueryInput,
"hasPassword": false,
"id": 123,
"in": [4],
"mimeType": "APPLICATION_MSWORD",
"name": "xyz789",
"nameIn": ["abc123"],
"notIn": [4],
"orderby": [PostObjectsConnectionOrderbyInput],
"parent": "4",
"parentIn": ["4"],
"parentNotIn": ["4"],
"password": "xyz789",
"search": "abc123",
"stati": ["ACF_DISABLED"],
"status": "ACF_DISABLED",
"title": "xyz789"
}
LandingPageToMobileImageConnection
Description
Connection between the landingPage type and the MediaItem type
Fields
| Field Name | Description |
|---|---|
edges - [LandingPageToMobileImageConnectionEdge!]!
|
Edges for the LandingPageToMobileImageConnection connection |
nodes - [MediaItem!]!
|
The nodes of the connection, without the edges |
pageInfo - LandingPageToMobileImageConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [LandingPageToMobileImageConnectionEdge],
"nodes": [MediaItem],
"pageInfo": LandingPageToMobileImageConnectionPageInfo
}
LandingPageToMobileImageConnectionEdge
Description
An edge in a connection
Fields
| Field Name | Description |
|---|---|
cursor - String
|
A cursor for use in pagination |
node - MediaItem!
|
The item at the end of the edge |
Example
{
"cursor": "abc123",
"node": MediaItem
}
LandingPageToMobileImageConnectionPageInfo
Description
Page Info on the "LandingPageToMobileImageConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "xyz789",
"hasNextPage": true,
"hasPreviousPage": false,
"startCursor": "abc123"
}
LandingPageToMobileImageConnectionWhereArgs
Description
Arguments for filtering the LandingPageToMobileImageConnection connection
Fields
| Input Field | Description |
|---|---|
contentTypes - [ContentTypeEnum]
|
The Types of content to filter |
dateQuery - DateQueryInput
|
Filter the connection based on dates |
hasPassword - Boolean
|
True for objects with passwords; False for objects without passwords; null for all objects with or without passwords |
id - Int
|
Specific database ID of the object |
in - [ID]
|
Array of IDs for the objects to retrieve |
mimeType - MimeTypeEnum
|
Get objects with a specific mimeType property |
name - String
|
Slug / post_name of the object |
nameIn - [String]
|
Specify objects to retrieve. Use slugs |
notIn - [ID]
|
Specify IDs NOT to retrieve. If this is used in the same query as "in", it will be ignored |
orderby - [PostObjectsConnectionOrderbyInput]
|
What parameter to use to order the objects by. |
parent - ID
|
Use ID to return only children. Use 0 to return only top-level items |
parentIn - [ID]
|
Specify objects whose parent is in an array |
parentNotIn - [ID]
|
Specify posts whose parent is not in an array |
password - String
|
Show posts with a specific password. |
search - String
|
Show Posts based on a keyword search |
stati - [PostStatusEnum]
|
Retrieve posts where post status is in an array. |
status - PostStatusEnum
|
Show posts with a specific status. |
title - String
|
Title of the object |
Example
{
"contentTypes": ["ATTACHMENT"],
"dateQuery": DateQueryInput,
"hasPassword": false,
"id": 987,
"in": ["4"],
"mimeType": "APPLICATION_MSWORD",
"name": "abc123",
"nameIn": ["abc123"],
"notIn": [4],
"orderby": [PostObjectsConnectionOrderbyInput],
"parent": "4",
"parentIn": ["4"],
"parentNotIn": ["4"],
"password": "xyz789",
"search": "abc123",
"stati": ["ACF_DISABLED"],
"status": "ACF_DISABLED",
"title": "abc123"
}
LandingPageToPreviewConnectionEdge
Description
Connection between the LandingPage type and the landingPage type
Fields
| Field Name | Description |
|---|---|
cursor - String
|
Opaque reference to the nodes position in the connection. Value can be used with pagination args. |
node - LandingPage!
|
The node of the connection, without the edges |
Example
{
"cursor": "xyz789",
"node": LandingPage
}
LandingPageToRevisionConnection
Description
Connection between the LandingPage type and the landingPage type
Fields
| Field Name | Description |
|---|---|
edges - [LandingPageToRevisionConnectionEdge!]!
|
Edges for the LandingPageToRevisionConnection connection |
nodes - [LandingPage!]!
|
The nodes of the connection, without the edges |
pageInfo - LandingPageToRevisionConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [LandingPageToRevisionConnectionEdge],
"nodes": [LandingPage],
"pageInfo": LandingPageToRevisionConnectionPageInfo
}
LandingPageToRevisionConnectionEdge
Description
An edge in a connection
Fields
| Field Name | Description |
|---|---|
cursor - String
|
A cursor for use in pagination |
node - LandingPage!
|
The item at the end of the edge |
Example
{
"cursor": "abc123",
"node": LandingPage
}
LandingPageToRevisionConnectionPageInfo
Description
Page Info on the "LandingPageToRevisionConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "xyz789",
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "xyz789"
}
LandingPageToRevisionConnectionWhereArgs
Description
Arguments for filtering the LandingPageToRevisionConnection connection
Fields
| Input Field | Description |
|---|---|
dateQuery - DateQueryInput
|
Filter the connection based on dates |
hasPassword - Boolean
|
True for objects with passwords; False for objects without passwords; null for all objects with or without passwords |
id - Int
|
Specific database ID of the object |
in - [ID]
|
Array of IDs for the objects to retrieve |
mimeType - MimeTypeEnum
|
Get objects with a specific mimeType property |
name - String
|
Slug / post_name of the object |
nameIn - [String]
|
Specify objects to retrieve. Use slugs |
notIn - [ID]
|
Specify IDs NOT to retrieve. If this is used in the same query as "in", it will be ignored |
orderby - [PostObjectsConnectionOrderbyInput]
|
What parameter to use to order the objects by. |
parent - ID
|
Use ID to return only children. Use 0 to return only top-level items |
parentIn - [ID]
|
Specify objects whose parent is in an array |
parentNotIn - [ID]
|
Specify posts whose parent is not in an array |
password - String
|
Show posts with a specific password. |
search - String
|
Show Posts based on a keyword search |
stati - [PostStatusEnum]
|
Retrieve posts where post status is in an array. |
status - PostStatusEnum
|
Show posts with a specific status. |
title - String
|
Title of the object |
Example
{
"dateQuery": DateQueryInput,
"hasPassword": true,
"id": 987,
"in": [4],
"mimeType": "APPLICATION_MSWORD",
"name": "xyz789",
"nameIn": ["abc123"],
"notIn": [4],
"orderby": [PostObjectsConnectionOrderbyInput],
"parent": "4",
"parentIn": [4],
"parentNotIn": ["4"],
"password": "xyz789",
"search": "abc123",
"stati": ["ACF_DISABLED"],
"status": "ACF_DISABLED",
"title": "abc123"
}
Language
Description
Language (Polylang)
Fields
| Field Name | Description |
|---|---|
code - LanguageCodeEnum
|
Language code (Polylang) |
homeUrl - String
|
Language term front page URL |
id - ID!
|
Language ID (Polylang) |
locale - String
|
Language locale (Polylang) |
name - String
|
Human readable language name (Polylang) |
slug - String
|
Language term slug. Prefer the "code" field if possible (Polylang) |
Example
{
"code": "EN",
"homeUrl": "xyz789",
"id": 4,
"locale": "abc123",
"name": "xyz789",
"slug": "abc123"
}
LanguageCodeEnum
Description
Enum of all available language codes
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"EN"
LanguageCodeFilterEnum
Description
Filter item by specific language, default language or list all languages
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ALL"
LayoutArticleHighlights
Description
Layout: LayoutArticleHighlights
Example
{
"anchor": "xyz789",
"articles": [Post],
"backgroundColor": "xyz789",
"category": 123,
"limit": 987,
"showMore": ["xyz789"],
"tag": 987,
"title": "xyz789"
}
LayoutArticles
Description
Layout: LayoutArticles
Example
{
"anchor": "xyz789",
"articles": [Post],
"backgroundColor": "xyz789",
"category": 987,
"limit": 987,
"showAllLink": "xyz789",
"tag": 123,
"title": "abc123"
}
LayoutArticlesCarousel
Description
Layout: LayoutArticlesCarousel
Example
{
"anchor": "abc123",
"articles": [Post],
"backgroundColor": "abc123",
"category": 123,
"limit": 987,
"showAllLink": "xyz789",
"showMore": ["abc123"],
"tag": 987,
"title": "abc123"
}
LayoutCard
Description
Layout: LayoutCard
Example
{
"alignment": "xyz789",
"backgroundColor": "abc123",
"description": "xyz789",
"image": Image,
"link": Link,
"title": "abc123"
}
LayoutCards
Description
Layout: LayoutCards
Fields
| Field Name | Description |
|---|---|
cards - [Card]
|
Cards |
Example
{"cards": [Card]}
LayoutCollection
Description
Layout: LayoutCollection
Fields
| Field Name | Description |
|---|---|
collection - Collection
|
Collection |
Example
{"collection": Collection}
LayoutContact
LayoutContent
LayoutImage
Description
Layout: LayoutImage
Example
{
"border": true,
"image": Image,
"photographer_name": "abc123",
"show_on_lightbox": true
}
LayoutImageGallery
Description
Layout: LayoutImageGallery
Fields
| Field Name | Description |
|---|---|
gallery - [GalleryImage]
|
Gallery |
Example
{"gallery": [GalleryImage]}
LayoutLinkList
Description
Layout: LayoutLinkList
Example
{
"anchor": "xyz789",
"backgroundColor": "abc123",
"description": "abc123",
"links": [Link],
"title": "abc123"
}
LayoutPages
Description
Layout: LayoutPages
Example
{
"anchor": "xyz789",
"backgroundColor": "xyz789",
"description": "xyz789",
"pages": [Page],
"showAllLink": "xyz789",
"title": "xyz789"
}
LayoutPagesCarousel
Description
Layout: LayoutPagesCarousel
Example
{
"anchor": "xyz789",
"backgroundColor": "abc123",
"description": "xyz789",
"pages": [Page],
"title": "xyz789"
}
LayoutSocialMediaFeed
LayoutSteps
Link
LocationsSelected
Description
Collection Module: LocationsSelected
Fields
| Field Name | Description |
|---|---|
locations - [Int]
|
List of location IDs |
module - String
|
Module type |
modules - [CollectionModulesUnionType]
|
List of modules |
title - String
|
Module title |
Example
{
"locations": [987],
"module": "xyz789",
"modules": [EventSearch],
"title": "xyz789"
}
LocationsSelectedCarousel
Description
Collection Module: LocationsSelectedCarousel
Fields
| Field Name | Description |
|---|---|
locations - [Int]
|
List of location IDs |
module - String
|
Module type |
modules - [CollectionModulesUnionType]
|
List of modules |
title - String
|
Module title |
Example
{
"locations": [123],
"module": "abc123",
"modules": [EventSearch],
"title": "abc123"
}
MediaDetails
Description
File details for a Media Item
Fields
| Field Name | Description |
|---|---|
file - String
|
The filename of the mediaItem |
height - Int
|
The height of the mediaItem |
meta - MediaItemMeta
|
Meta information associated with the mediaItem |
sizes - [MediaSize]
|
The available sizes of the mediaItem |
Arguments
|
|
width - Int
|
The width of the mediaItem |
Example
{
"file": "xyz789",
"height": 123,
"meta": MediaItemMeta,
"sizes": [MediaSize],
"width": 987
}
MediaItem
Description
The mediaItem type
Fields
| Field Name | Description |
|---|---|
altText - String
|
Alternative text to display when resource is not displayed |
ancestors - HierarchicalContentNodeToContentNodeAncestorsConnection
|
Returns ancestors of the node. Default ordered as lowest (closest to the child) to highest (closest to the root). |
Arguments
|
|
author - NodeWithAuthorToUserConnectionEdge
|
Connection between the NodeWithAuthor type and the User type |
authorDatabaseId - Int
|
The database identifier of the author of the node |
authorId - ID
|
The globally unique identifier of the author of the node |
caption - String
|
The caption for the resource |
Arguments
|
|
children - HierarchicalContentNodeToContentNodeChildrenConnection
|
Connection between the HierarchicalContentNode type and the ContentNode type |
Arguments
|
|
contentType - ContentNodeToContentTypeConnectionEdge
|
Connection between the ContentNode type and the ContentType type |
contentTypeName - String!
|
The name of the Content Type the node belongs to |
databaseId - Int!
|
The unique identifier stored in the database |
date - String
|
Post publishing date. |
dateGmt - String
|
The publishing date set in GMT. |
description - String
|
Description of the image (stored as post_content) |
Arguments
|
|
desiredSlug - String
|
The desired slug of the post |
editingLockedBy - ContentNodeToEditLockConnectionEdge
|
If a user has edited the node within the past 15 seconds, this will return the user that last edited. Null if the edit lock doesn't exist or is greater than 15 seconds |
enclosure - String
|
The RSS enclosure for the object |
enqueuedScripts - ContentNodeToEnqueuedScriptConnection
|
Connection between the ContentNode type and the EnqueuedScript type |
Arguments
|
|
enqueuedStylesheets - ContentNodeToEnqueuedStylesheetConnection
|
Connection between the ContentNode type and the EnqueuedStylesheet type |
Arguments
|
|
fileSize - Int
|
The filesize in bytes of the resource |
Arguments
|
|
guid - String
|
The global unique identifier for this post. This currently matches the value stored in WP_Post->guid and the guid column in the "post_objects" database table. |
id - ID!
|
The globally unique identifier of the attachment object. |
isComment - Boolean!
|
Whether the node is a Comment |
isContentNode - Boolean!
|
Whether the node is a Content Node |
isFrontPage - Boolean!
|
Whether the node represents the front page. |
isPostsPage - Boolean!
|
Whether the node represents the blog page. |
isPreview - Boolean
|
Whether the object is a node in the preview state |
isRestricted - Boolean
|
Whether the object is restricted from the current viewer |
isTermNode - Boolean!
|
Whether the node is a Term |
language - Language
|
Polylang language |
lastEditedBy - ContentNodeToEditLastConnectionEdge
|
The user that most recently edited the node |
link - String
|
The permalink of the post |
mediaDetails - MediaDetails
|
Details about the mediaItem |
mediaItemId - Int!
|
The id field matches the WP_Post->ID field. Deprecated in favor of the databaseId field |
mediaItemUrl - String
|
Url of the mediaItem |
mediaType - String
|
Type of resource |
mimeType - String
|
The mime type of the mediaItem |
modified - String
|
The local modified time for a post. If a post was recently updated the modified field will change to match the corresponding time. |
modifiedGmt - String
|
The GMT modified time for a post. If a post was recently updated the modified field will change to match the corresponding time in GMT. |
parent - HierarchicalContentNodeToParentContentNodeConnectionEdge
|
The parent of the node. The parent object can be of various types |
parentDatabaseId - Int
|
Database id of the parent node |
parentId - ID
|
The globally unique identifier of the parent node. |
photographerName - String
|
Valokuvaajan tiedot |
previewRevisionDatabaseId - Int
|
The database id of the preview node |
previewRevisionId - ID
|
Whether the object is a node in the preview state |
seo - SEO
|
The SEO Framework data of the mediaItem |
sizes - String
|
The sizes attribute value for an image. |
Arguments
|
|
slug - String
|
The uri slug for the post. This is equivalent to the WP_Post->post_name field and the post_name column in the database for the "post_objects" table. |
sourceUrl - String
|
Url of the mediaItem |
Arguments
|
|
srcSet - String
|
The srcset attribute specifies the URL of the image to use in different situations. It is a comma separated string of urls and their widths. |
Arguments
|
|
status - String
|
The current status of the object |
template - ContentTemplate
|
The template assigned to a node of content |
title - String
|
The title of the post. This is currently just the raw title. An amendment to support rendered title needs to be made. |
Arguments
|
|
translation - MediaItem
|
Get specific translation version of this object |
Arguments
|
|
translations - [MediaItem]
|
List all translated versions of this post |
uri - String
|
The unique resource identifier path |
Example
{
"altText": "abc123",
"ancestors": HierarchicalContentNodeToContentNodeAncestorsConnection,
"author": NodeWithAuthorToUserConnectionEdge,
"authorDatabaseId": 123,
"authorId": "4",
"caption": "abc123",
"children": HierarchicalContentNodeToContentNodeChildrenConnection,
"contentType": ContentNodeToContentTypeConnectionEdge,
"contentTypeName": "abc123",
"databaseId": 123,
"date": "abc123",
"dateGmt": "xyz789",
"description": "abc123",
"desiredSlug": "xyz789",
"editingLockedBy": ContentNodeToEditLockConnectionEdge,
"enclosure": "abc123",
"enqueuedScripts": ContentNodeToEnqueuedScriptConnection,
"enqueuedStylesheets": ContentNodeToEnqueuedStylesheetConnection,
"fileSize": 123,
"guid": "abc123",
"id": "4",
"isComment": true,
"isContentNode": false,
"isFrontPage": false,
"isPostsPage": false,
"isPreview": true,
"isRestricted": false,
"isTermNode": true,
"language": Language,
"lastEditedBy": ContentNodeToEditLastConnectionEdge,
"link": "abc123",
"mediaDetails": MediaDetails,
"mediaItemId": 123,
"mediaItemUrl": "abc123",
"mediaType": "xyz789",
"mimeType": "xyz789",
"modified": "abc123",
"modifiedGmt": "abc123",
"parent": HierarchicalContentNodeToParentContentNodeConnectionEdge,
"parentDatabaseId": 123,
"parentId": 4,
"photographerName": "abc123",
"previewRevisionDatabaseId": 123,
"previewRevisionId": 4,
"seo": SEO,
"sizes": "xyz789",
"slug": "xyz789",
"sourceUrl": "xyz789",
"srcSet": "abc123",
"status": "abc123",
"template": ContentTemplate,
"title": "xyz789",
"translation": MediaItem,
"translations": [MediaItem],
"uri": "abc123"
}
MediaItemConnection
Description
Connection to mediaItem Nodes
Fields
| Field Name | Description |
|---|---|
edges - [MediaItemConnectionEdge!]!
|
A list of edges (relational context) between RootQuery and connected mediaItem Nodes |
nodes - [MediaItem!]!
|
A list of connected mediaItem Nodes |
pageInfo - MediaItemConnectionPageInfo!
|
Information about pagination in a connection. |
Possible Types
| MediaItemConnection Types |
|---|
Example
{
"edges": [MediaItemConnectionEdge],
"nodes": [MediaItem],
"pageInfo": MediaItemConnectionPageInfo
}
MediaItemConnectionEdge
Description
Edge between a Node and a connected mediaItem
Fields
| Field Name | Description |
|---|---|
cursor - String
|
Opaque reference to the nodes position in the connection. Value can be used with pagination args. |
node - MediaItem!
|
The connected mediaItem Node |
Example
{
"cursor": "xyz789",
"node": MediaItem
}
MediaItemConnectionPageInfo
Description
Page Info on the connected MediaItemConnectionEdge
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Possible Types
| MediaItemConnectionPageInfo Types |
|---|
Example
{
"endCursor": "abc123",
"hasNextPage": false,
"hasPreviousPage": true,
"startCursor": "xyz789"
}
MediaItemIdType
Description
The Type of Identifier used to fetch a single resource. Default is ID.
Values
| Enum Value | Description |
|---|---|
|
|
Identify a resource by the Database ID. |
|
|
Identify a resource by the (hashed) Global ID. |
|
|
Identify a resource by the slug. Available to non-hierarchcial Types where the slug is a unique identifier. |
|
|
Identify a media item by its source url |
|
|
Identify a resource by the URI. |
Example
"DATABASE_ID"
MediaItemMeta
Description
Meta connected to a MediaItem
Fields
| Field Name | Description |
|---|---|
aperture - Float
|
Aperture measurement of the media item. |
camera - String
|
Information about the camera used to create the media item. |
caption - String
|
The text string description associated with the media item. |
copyright - String
|
Copyright information associated with the media item. |
createdTimestamp - Int
|
The date/time when the media was created. |
credit - String
|
The original creator of the media item. |
focalLength - Float
|
The focal length value of the media item. |
iso - Int
|
The ISO (International Organization for Standardization) value of the media item. |
keywords - [String]
|
List of keywords used to describe or identfy the media item. |
orientation - String
|
The vertical or horizontal aspect of the media item. |
shutterSpeed - Float
|
The shutter speed information of the media item. |
title - String
|
A useful title for the media item. |
Example
{
"aperture": 987.65,
"camera": "abc123",
"caption": "xyz789",
"copyright": "abc123",
"createdTimestamp": 987,
"credit": "xyz789",
"focalLength": 123.45,
"iso": 987,
"keywords": ["xyz789"],
"orientation": "abc123",
"shutterSpeed": 123.45,
"title": "xyz789"
}
MediaItemSizeEnum
Description
The size of the media item object.
Values
| Enum Value | Description |
|---|---|
|
|
MediaItem with the large size |
|
|
MediaItem with the medium size |
|
|
MediaItem with the medium_large size |
|
|
MediaItem with the thumbnail size |
|
|
MediaItem with the 1536x1536 size |
|
|
MediaItem with the 2048x2048 size |
Example
"LARGE"
MediaItemStatusEnum
Description
The status of the media item object.
Values
| Enum Value | Description |
|---|---|
|
|
Objects with the auto-draft status |
|
|
Objects with the inherit status |
|
|
Objects with the private status |
|
|
Objects with the trash status |
Example
"AUTO_DRAFT"
MediaSize
Description
Details of an available size for a media item
Fields
| Field Name | Description |
|---|---|
file - String
|
The filename of the referenced size |
fileSize - Int
|
The filesize of the resource |
height - String
|
The height of the referenced size |
mimeType - String
|
The mime type of the referenced size |
name - String
|
The referenced size name |
sourceUrl - String
|
The url of the referenced size |
width - String
|
The width of the referenced size |
Example
{
"file": "abc123",
"fileSize": 987,
"height": "xyz789",
"mimeType": "abc123",
"name": "abc123",
"sourceUrl": "xyz789",
"width": "xyz789"
}
Menu
Description
Menus are the containers for navigation items. Menus can be assigned to menu locations, which are typically registered by the active theme.
Fields
| Field Name | Description |
|---|---|
count - Int
|
The number of items in the menu |
databaseId - Int!
|
The unique identifier stored in the database |
id - ID!
|
The globally unique identifier of the nav menu object. |
isRestricted - Boolean
|
Whether the object is restricted from the current viewer |
locations - [MenuLocationEnum]
|
The locations a menu is assigned to |
menuId - Int
|
WP ID of the nav menu. Deprecated in favor of the databaseId field |
menuItems - MenuToMenuItemConnection
|
Connection between the Menu type and the MenuItem type |
Arguments
|
|
name - String
|
Display name of the menu. Equivalent to WP_Term->name. |
slug - String
|
The url friendly name of the menu. Equivalent to WP_Term->slug |
Example
{
"count": 123,
"databaseId": 123,
"id": "4",
"isRestricted": true,
"locations": ["PRIMARY"],
"menuId": 987,
"menuItems": MenuToMenuItemConnection,
"name": "abc123",
"slug": "abc123"
}
MenuConnection
Description
Connection to Menu Nodes
Fields
| Field Name | Description |
|---|---|
edges - [MenuConnectionEdge!]!
|
A list of edges (relational context) between RootQuery and connected Menu Nodes |
nodes - [Menu!]!
|
A list of connected Menu Nodes |
pageInfo - MenuConnectionPageInfo!
|
Information about pagination in a connection. |
Possible Types
| MenuConnection Types |
|---|
Example
{
"edges": [MenuConnectionEdge],
"nodes": [Menu],
"pageInfo": MenuConnectionPageInfo
}
MenuConnectionEdge
Description
Edge between a Node and a connected Menu
Fields
| Field Name | Description |
|---|---|
cursor - String
|
Opaque reference to the nodes position in the connection. Value can be used with pagination args. |
node - Menu!
|
The connected Menu Node |
Possible Types
| MenuConnectionEdge Types |
|---|
Example
{
"cursor": "abc123",
"node": Menu
}
MenuConnectionPageInfo
Description
Page Info on the connected MenuConnectionEdge
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Possible Types
| MenuConnectionPageInfo Types |
|---|
Example
{
"endCursor": "abc123",
"hasNextPage": true,
"hasPreviousPage": false,
"startCursor": "xyz789"
}
MenuItem
Description
Navigation menu items are the individual items assigned to a menu. These are rendered as the links in a navigation menu.
Fields
| Field Name | Description |
|---|---|
childItems - MenuItemToMenuItemConnection
|
Connection between the MenuItem type and the MenuItem type |
Arguments
|
|
connectedNode - MenuItemToMenuItemLinkableConnectionEdge
|
Connection from MenuItem to it's connected node |
connectedObject - MenuItemObjectUnion
|
The object connected to this menu item. Deprecated in favor of the connectedNode field |
cssClasses - [String]
|
Class attribute for the menu item link |
databaseId - Int!
|
The unique identifier stored in the database |
description - String
|
Description of the menu item. |
id - ID!
|
The globally unique identifier of the nav menu item object. |
isRestricted - Boolean
|
Whether the object is restricted from the current viewer |
label - String
|
Label or title of the menu item. |
linkRelationship - String
|
Link relationship (XFN) of the menu item. |
locations - [MenuLocationEnum]
|
The locations the menu item's Menu is assigned to |
menu - MenuItemToMenuConnectionEdge
|
The Menu a MenuItem is part of |
menuItemId - Int
|
WP ID of the menu item. Deprecated in favor of the databaseId field |
order - Int
|
Menu item order |
parentDatabaseId - Int
|
The database id of the parent menu item or null if it is the root |
parentId - ID
|
The globally unique identifier of the parent nav menu item object. |
path - String
|
Path for the resource. Relative path for internal resources. Absolute path for external resources. |
target - String
|
Target attribute for the menu item link. |
title - String
|
Title attribute for the menu item link |
uri - String
|
The uri of the resource the menu item links to |
url - String
|
URL or destination of the menu item. |
Example
{
"childItems": MenuItemToMenuItemConnection,
"connectedNode": MenuItemToMenuItemLinkableConnectionEdge,
"connectedObject": Post,
"cssClasses": ["abc123"],
"databaseId": 123,
"description": "abc123",
"id": "4",
"isRestricted": false,
"label": "xyz789",
"linkRelationship": "xyz789",
"locations": ["PRIMARY"],
"menu": MenuItemToMenuConnectionEdge,
"menuItemId": 123,
"order": 987,
"parentDatabaseId": 123,
"parentId": "4",
"path": "xyz789",
"target": "xyz789",
"title": "xyz789",
"uri": "abc123",
"url": "abc123"
}
MenuItemConnection
Description
Connection to MenuItem Nodes
Fields
| Field Name | Description |
|---|---|
edges - [MenuItemConnectionEdge!]!
|
A list of edges (relational context) between RootQuery and connected MenuItem Nodes |
nodes - [MenuItem!]!
|
A list of connected MenuItem Nodes |
pageInfo - MenuItemConnectionPageInfo!
|
Information about pagination in a connection. |
Possible Types
| MenuItemConnection Types |
|---|
Example
{
"edges": [MenuItemConnectionEdge],
"nodes": [MenuItem],
"pageInfo": MenuItemConnectionPageInfo
}
MenuItemConnectionEdge
Description
Edge between a Node and a connected MenuItem
Fields
| Field Name | Description |
|---|---|
cursor - String
|
Opaque reference to the nodes position in the connection. Value can be used with pagination args. |
node - MenuItem!
|
The connected MenuItem Node |
Possible Types
| MenuItemConnectionEdge Types |
|---|
Example
{
"cursor": "abc123",
"node": MenuItem
}
MenuItemConnectionPageInfo
Description
Page Info on the connected MenuItemConnectionEdge
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Possible Types
| MenuItemConnectionPageInfo Types |
|---|
Example
{
"endCursor": "xyz789",
"hasNextPage": false,
"hasPreviousPage": true,
"startCursor": "xyz789"
}
MenuItemLinkable
Description
Nodes that can be linked to as Menu Items
Fields
| Field Name | Description |
|---|---|
databaseId - Int!
|
The unique identifier stored in the database |
id - ID!
|
The globally unique ID for the object |
isComment - Boolean!
|
Whether the node is a Comment |
isContentNode - Boolean!
|
Whether the node is a Content Node |
isFrontPage - Boolean!
|
Whether the node represents the front page. |
isPostsPage - Boolean!
|
Whether the node represents the blog page. |
isTermNode - Boolean!
|
Whether the node is a Term |
uri - String
|
The unique resource identifier path |
Example
{
"databaseId": 123,
"id": "4",
"isComment": false,
"isContentNode": false,
"isFrontPage": true,
"isPostsPage": true,
"isTermNode": false,
"uri": "xyz789"
}
MenuItemLinkableConnectionEdge
Description
Edge between a Node and a connected MenuItemLinkable
Fields
| Field Name | Description |
|---|---|
cursor - String
|
Opaque reference to the nodes position in the connection. Value can be used with pagination args. |
node - MenuItemLinkable!
|
The connected MenuItemLinkable Node |
Possible Types
| MenuItemLinkableConnectionEdge Types |
|---|
Example
{
"cursor": "xyz789",
"node": MenuItemLinkable
}
MenuItemNodeIdTypeEnum
Description
The Type of Identifier used to fetch a single node. Default is "ID". To be used along with the "id" field.
Values
| Enum Value | Description |
|---|---|
|
|
Identify a resource by the Database ID. |
|
|
Identify a resource by the (hashed) Global ID. |
Example
"DATABASE_ID"
MenuItemObjectUnion
MenuItemToMenuConnectionEdge
Description
Connection between the MenuItem type and the Menu type
Example
{
"cursor": "xyz789",
"node": Menu
}
MenuItemToMenuItemConnection
Description
Connection between the MenuItem type and the MenuItem type
Fields
| Field Name | Description |
|---|---|
edges - [MenuItemToMenuItemConnectionEdge!]!
|
Edges for the MenuItemToMenuItemConnection connection |
nodes - [MenuItem!]!
|
The nodes of the connection, without the edges |
pageInfo - MenuItemToMenuItemConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [MenuItemToMenuItemConnectionEdge],
"nodes": [MenuItem],
"pageInfo": MenuItemToMenuItemConnectionPageInfo
}
MenuItemToMenuItemConnectionEdge
MenuItemToMenuItemConnectionPageInfo
Description
Page Info on the "MenuItemToMenuItemConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "abc123",
"hasNextPage": false,
"hasPreviousPage": true,
"startCursor": "xyz789"
}
MenuItemToMenuItemConnectionWhereArgs
Description
Arguments for filtering the MenuItemToMenuItemConnection connection
Fields
| Input Field | Description |
|---|---|
id - Int
|
The database ID of the object |
location - MenuLocationEnum
|
The menu location for the menu being queried |
parentDatabaseId - Int
|
The database ID of the parent menu object |
parentId - ID
|
The ID of the parent menu object |
Example
{"id": 123, "location": "PRIMARY", "parentDatabaseId": 123, "parentId": 4}
MenuItemToMenuItemLinkableConnectionEdge
Description
Connection between the MenuItem type and the MenuItemLinkable type
Fields
| Field Name | Description |
|---|---|
cursor - String
|
Opaque reference to the nodes position in the connection. Value can be used with pagination args. |
node - MenuItemLinkable!
|
The node of the connection, without the edges |
Example
{
"cursor": "xyz789",
"node": MenuItemLinkable
}
MenuLocationEnum
Description
Registered menu locations
Values
| Enum Value | Description |
|---|---|
|
|
Put the menu in the primary location |
|
|
Put the menu in the primary___en location |
|
|
Put the menu in the primary___sv location |
|
|
Put the menu in the secondary location |
|
|
Put the menu in the secondary___en location |
|
|
Put the menu in the secondary___sv location |
|
|
Put the menu in the tertiary location |
|
|
Put the menu in the tertiary___en location |
|
|
Put the menu in the tertiary___sv location |
Example
"PRIMARY"
MenuNodeIdTypeEnum
Description
The Type of Identifier used to fetch a single node. Default is "ID". To be used along with the "id" field.
Values
| Enum Value | Description |
|---|---|
|
|
Identify a menu node by the Database ID. |
|
|
Identify a menu node by the (hashed) Global ID. |
|
|
Identify a menu node by the slug of menu location to which it is assigned |
|
|
Identify a menu node by its name |
|
|
Identify a menu node by its slug |
Example
"DATABASE_ID"
MenuToMenuItemConnection
Description
Connection between the Menu type and the MenuItem type
Fields
| Field Name | Description |
|---|---|
edges - [MenuToMenuItemConnectionEdge!]!
|
Edges for the MenuToMenuItemConnection connection |
nodes - [MenuItem!]!
|
The nodes of the connection, without the edges |
pageInfo - MenuToMenuItemConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [MenuToMenuItemConnectionEdge],
"nodes": [MenuItem],
"pageInfo": MenuToMenuItemConnectionPageInfo
}
MenuToMenuItemConnectionEdge
MenuToMenuItemConnectionPageInfo
Description
Page Info on the "MenuToMenuItemConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "abc123",
"hasNextPage": false,
"hasPreviousPage": true,
"startCursor": "abc123"
}
MenuToMenuItemConnectionWhereArgs
Description
Arguments for filtering the MenuToMenuItemConnection connection
Fields
| Input Field | Description |
|---|---|
id - Int
|
The database ID of the object |
location - MenuLocationEnum
|
The menu location for the menu being queried |
parentDatabaseId - Int
|
The database ID of the parent menu object |
parentId - ID
|
The ID of the parent menu object |
Example
{
"id": 123,
"location": "PRIMARY",
"parentDatabaseId": 987,
"parentId": "4"
}
MimeTypeEnum
Description
The MimeType of the object
Values
| Enum Value | Description |
|---|---|
|
|
application/msword mime type. |
|
|
application/pdf mime type. |
|
|
application/vnd.apple.keynote mime type. |
|
|
application/vnd.ms-excel mime type. |
|
|
application/vnd.ms-excel.sheet.binary.macroEnabled.12 mime type. |
|
|
application/vnd.ms-excel.sheet.macroEnabled.12 mime type. |
|
|
application/vnd.ms-powerpoint mime type. |
|
|
application/vnd.ms-powerpoint.presentation.macroEnabled.12 mime type. |
|
|
application/vnd.ms-powerpoint.slideshow.macroEnabled.12 mime type. |
|
|
application/vnd.ms-word.document.macroEnabled.12 mime type. |
|
|
application/vnd.oasis.opendocument.text mime type. |
|
|
application/vnd.openxmlformats-officedocument.presentationml.presentation mime type. |
|
|
application/vnd.openxmlformats-officedocument.presentationml.slideshow mime type. |
|
|
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet mime type. |
|
|
application/vnd.openxmlformats-officedocument.wordprocessingml.document mime type. |
|
|
audio/flac mime type. |
|
|
audio/midi mime type. |
|
|
audio/mpeg mime type. |
|
|
audio/ogg mime type. |
|
|
audio/wav mime type. |
|
|
image/gif mime type. |
|
|
image/jpeg mime type. |
|
|
image/png mime type. |
|
|
video/3gpp mime type. |
|
|
video/3gpp2 mime type. |
|
|
video/avi mime type. |
|
|
video/mp4 mime type. |
|
|
video/mpeg mime type. |
|
|
video/ogg mime type. |
|
|
video/quicktime mime type. |
|
|
video/webm mime type. |
|
|
video/x-flv mime type. |
Example
"APPLICATION_MSWORD"
Node
Description
An object with an ID
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The globally unique ID for the object |
Possible Types
| Node Types |
|---|
Example
{"id": 4}
NodeWithAuthor
Description
A node that can have an author assigned to it
Fields
| Field Name | Description |
|---|---|
author - NodeWithAuthorToUserConnectionEdge
|
Connection between the NodeWithAuthor type and the User type |
authorDatabaseId - Int
|
The database identifier of the author of the node |
authorId - ID
|
The globally unique identifier of the author of the node |
id - ID!
|
The globally unique ID for the object |
Example
{
"author": NodeWithAuthorToUserConnectionEdge,
"authorDatabaseId": 987,
"authorId": 4,
"id": "4"
}
NodeWithAuthorToUserConnectionEdge
Description
Connection between the NodeWithAuthor type and the User type
Example
{
"cursor": "abc123",
"node": User
}
NodeWithContentEditor
Description
A node that supports the content editor
Fields
| Field Name | Description |
|---|---|
content - String
|
The content of the post. |
Arguments
|
|
id - ID!
|
The globally unique ID for the object |
Example
{
"content": "abc123",
"id": "4"
}
NodeWithFeaturedImage
Description
A node that can have a featured image set
Fields
| Field Name | Description |
|---|---|
featuredImage - NodeWithFeaturedImageToMediaItemConnectionEdge
|
Connection between the NodeWithFeaturedImage type and the MediaItem type |
featuredImageDatabaseId - Int
|
The database identifier for the featured image node assigned to the content node |
featuredImageId - ID
|
Globally unique ID of the featured image assigned to the node |
id - ID!
|
The globally unique ID for the object |
Example
{
"featuredImage": NodeWithFeaturedImageToMediaItemConnectionEdge,
"featuredImageDatabaseId": 123,
"featuredImageId": "4",
"id": 4
}
NodeWithFeaturedImageToMediaItemConnectionEdge
Description
Connection between the NodeWithFeaturedImage type and the MediaItem type
Fields
| Field Name | Description |
|---|---|
cursor - String
|
Opaque reference to the nodes position in the connection. Value can be used with pagination args. |
node - MediaItem!
|
The node of the connection, without the edges |
Example
{
"cursor": "abc123",
"node": MediaItem
}
NodeWithPageAttributes
Description
A node that can have page attributes
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The globally unique ID for the object |
menuOrder - Int
|
A field used for ordering posts. This is typically used with nav menu items or for special ordering of hierarchical content types. |
Possible Types
| NodeWithPageAttributes Types |
|---|
Example
{"id": 4, "menuOrder": 987}
NodeWithRevisions
Description
A node that can have revisions
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The globally unique ID for the object |
isRevision - Boolean
|
True if the node is a revision of another node |
revisionOf - NodeWithRevisionsToContentNodeConnectionEdge
|
If the current node is a revision, this field exposes the node this is a revision of. Returns null if the node is not a revision of another node. |
Possible Types
| NodeWithRevisions Types |
|---|
Example
{
"id": 4,
"isRevision": false,
"revisionOf": NodeWithRevisionsToContentNodeConnectionEdge
}
NodeWithRevisionsToContentNodeConnectionEdge
Description
Connection between the NodeWithRevisions type and the ContentNode type
Fields
| Field Name | Description |
|---|---|
cursor - String
|
Opaque reference to the nodes position in the connection. Value can be used with pagination args. |
node - ContentNode!
|
The node of the connection, without the edges |
Example
{
"cursor": "xyz789",
"node": ContentNode
}
NodeWithTemplate
Description
A node that can have a template associated with it
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The globally unique ID for the object |
template - ContentTemplate
|
The template assigned to the node |
Possible Types
| NodeWithTemplate Types |
|---|
Example
{"id": 4, "template": ContentTemplate}
NodeWithTitle
Description
A node that NodeWith a title
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The globally unique ID for the object |
title - String
|
The title of the post. This is currently just the raw title. An amendment to support rendered title needs to be made. |
Arguments
|
|
Possible Types
| NodeWithTitle Types |
|---|
Example
{"id": 4, "title": "abc123"}
Notification
Description
Describe what a CustomType is
Example
{
"content": "abc123",
"endDate": "abc123",
"level": "xyz789",
"linkText": "abc123",
"linkUrl": "abc123",
"startDate": "abc123",
"title": "xyz789"
}
OneToOneConnection
Description
A singular connection from one Node to another, with support for relational data on the "edge" of the connection.
Fields
| Field Name | Description |
|---|---|
cursor - String
|
Opaque reference to the nodes position in the connection. Value can be used with pagination args. |
node - Node!
|
The connected node |
Possible Types
| OneToOneConnection Types |
|---|
Example
{
"cursor": "abc123",
"node": Node
}
OrderEnum
Description
The cardinality of the connection order
Values
| Enum Value | Description |
|---|---|
|
|
Sort the query result set in an ascending order |
|
|
Sort the query result set in a descending order |
Example
"ASC"
Page
Description
The page type
Fields
| Field Name | Description |
|---|---|
ancestors - HierarchicalContentNodeToContentNodeAncestorsConnection
|
Returns ancestors of the node. Default ordered as lowest (closest to the child) to highest (closest to the root). |
Arguments
|
|
author - NodeWithAuthorToUserConnectionEdge
|
Connection between the NodeWithAuthor type and the User type |
authorDatabaseId - Int
|
The database identifier of the author of the node |
authorId - ID
|
The globally unique identifier of the author of the node |
breadcrumbs - [Breadcrumb]
|
Breadcrumb fields |
children - HierarchicalContentNodeToContentNodeChildrenConnection
|
Connection between the HierarchicalContentNode type and the ContentNode type |
Arguments
|
|
content - String
|
The content of the post. |
Arguments
|
|
contentType - ContentNodeToContentTypeConnectionEdge
|
Connection between the ContentNode type and the ContentType type |
contentTypeName - String!
|
The name of the Content Type the node belongs to |
databaseId - Int!
|
The unique identifier stored in the database |
date - String
|
Post publishing date. |
dateGmt - String
|
The publishing date set in GMT. |
desiredSlug - String
|
The desired slug of the post |
editingLockedBy - ContentNodeToEditLockConnectionEdge
|
If a user has edited the node within the past 15 seconds, this will return the user that last edited. Null if the edit lock doesn't exist or is greater than 15 seconds |
enclosure - String
|
The RSS enclosure for the object |
enqueuedScripts - ContentNodeToEnqueuedScriptConnection
|
Connection between the ContentNode type and the EnqueuedScript type |
Arguments
|
|
enqueuedStylesheets - ContentNodeToEnqueuedStylesheetConnection
|
Connection between the ContentNode type and the EnqueuedStylesheet type |
Arguments
|
|
expirationTime - String
|
Vanhentumisaika |
featuredImage - NodeWithFeaturedImageToMediaItemConnectionEdge
|
Connection between the NodeWithFeaturedImage type and the MediaItem type |
featuredImageDatabaseId - Int
|
The database identifier for the featured image node assigned to the content node |
featuredImageId - ID
|
Globally unique ID of the featured image assigned to the node |
guid - String
|
The global unique identifier for this post. This currently matches the value stored in WP_Post->guid and the guid column in the "post_objects" database table. |
hero - Hero
|
Hero fields |
id - ID!
|
The globally unique identifier of the page object. |
isComment - Boolean!
|
Whether the node is a Comment |
isContentNode - Boolean!
|
Whether the node is a Content Node |
isFrontPage - Boolean!
|
Whether this page is set to the static front page. |
isPostsPage - Boolean!
|
Whether this page is set to the blog posts page. |
isPreview - Boolean
|
Whether the object is a node in the preview state |
isPrivacyPage - Boolean!
|
Whether this page is set to the privacy page. |
isRestricted - Boolean
|
Whether the object is restricted from the current viewer |
isRevision - Boolean
|
True if the node is a revision of another node |
isTermNode - Boolean!
|
Whether the node is a Term |
language - Language
|
Polylang language |
lastEditedBy - ContentNodeToEditLastConnectionEdge
|
The user that most recently edited the node |
lead - String
|
Ingressi |
link - String
|
The permalink of the post |
menuOrder - Int
|
A field used for ordering posts. This is typically used with nav menu items or for special ordering of hierarchical content types. |
modified - String
|
The local modified time for a post. If a post was recently updated the modified field will change to match the corresponding time. |
modifiedGmt - String
|
The GMT modified time for a post. If a post was recently updated the modified field will change to match the corresponding time in GMT. |
modules - [PageModulesUnionType]
|
List of modules |
pageId - Int!
|
The id field matches the WP_Post->ID field. Deprecated in favor of the databaseId field |
parent - HierarchicalContentNodeToParentContentNodeConnectionEdge
|
The parent of the node. The parent object can be of various types |
parentDatabaseId - Int
|
Database id of the parent node |
parentId - ID
|
The globally unique identifier of the parent node. |
preview - PageToPreviewConnectionEdge
|
Connection between the Page type and the page type |
previewRevisionDatabaseId - Int
|
The database id of the preview node |
previewRevisionId - ID
|
Whether the object is a node in the preview state |
revisionOf - NodeWithRevisionsToContentNodeConnectionEdge
|
If the current node is a revision, this field exposes the node this is a revision of. Returns null if the node is not a revision of another node. |
revisions - PageToRevisionConnection
|
Connection between the Page type and the page type |
Arguments
|
|
seo - SEO
|
The SEO Framework data of the page |
showChildPages - Boolean
|
Näytä alisivut |
sidebar - [PageSidebarUnionType]
|
List of modules |
slug - String
|
The uri slug for the post. This is equivalent to the WP_Post->post_name field and the post_name column in the database for the "post_objects" table. |
status - String
|
The current status of the object |
template - ContentTemplate
|
The template assigned to a node of content |
title - String
|
The title of the post. This is currently just the raw title. An amendment to support rendered title needs to be made. |
Arguments
|
|
translation - Page
|
Get specific translation version of this object |
Arguments
|
|
translations - [Page]
|
List all translated versions of this post |
uri - String
|
The unique resource identifier path |
Example
{
"ancestors": HierarchicalContentNodeToContentNodeAncestorsConnection,
"author": NodeWithAuthorToUserConnectionEdge,
"authorDatabaseId": 123,
"authorId": "4",
"breadcrumbs": [Breadcrumb],
"children": HierarchicalContentNodeToContentNodeChildrenConnection,
"content": "abc123",
"contentType": ContentNodeToContentTypeConnectionEdge,
"contentTypeName": "xyz789",
"databaseId": 987,
"date": "xyz789",
"dateGmt": "xyz789",
"desiredSlug": "abc123",
"editingLockedBy": ContentNodeToEditLockConnectionEdge,
"enclosure": "xyz789",
"enqueuedScripts": ContentNodeToEnqueuedScriptConnection,
"enqueuedStylesheets": ContentNodeToEnqueuedStylesheetConnection,
"expirationTime": "xyz789",
"featuredImage": NodeWithFeaturedImageToMediaItemConnectionEdge,
"featuredImageDatabaseId": 123,
"featuredImageId": 4,
"guid": "abc123",
"hero": Hero,
"id": "4",
"isComment": false,
"isContentNode": true,
"isFrontPage": true,
"isPostsPage": true,
"isPreview": true,
"isPrivacyPage": false,
"isRestricted": true,
"isRevision": false,
"isTermNode": true,
"language": Language,
"lastEditedBy": ContentNodeToEditLastConnectionEdge,
"lead": "xyz789",
"link": "abc123",
"menuOrder": 123,
"modified": "xyz789",
"modifiedGmt": "xyz789",
"modules": [EventSearch],
"pageId": 987,
"parent": HierarchicalContentNodeToParentContentNodeConnectionEdge,
"parentDatabaseId": 987,
"parentId": "4",
"preview": PageToPreviewConnectionEdge,
"previewRevisionDatabaseId": 123,
"previewRevisionId": "4",
"revisionOf": NodeWithRevisionsToContentNodeConnectionEdge,
"revisions": PageToRevisionConnection,
"seo": SEO,
"showChildPages": true,
"sidebar": [LayoutLinkList],
"slug": "abc123",
"status": "abc123",
"template": ContentTemplate,
"title": "xyz789",
"translation": Page,
"translations": [Page],
"uri": "xyz789"
}
PageConnection
Description
Connection to page Nodes
Fields
| Field Name | Description |
|---|---|
edges - [PageConnectionEdge!]!
|
A list of edges (relational context) between RootQuery and connected page Nodes |
nodes - [Page!]!
|
A list of connected page Nodes |
pageInfo - PageConnectionPageInfo!
|
Information about pagination in a connection. |
Possible Types
| PageConnection Types |
|---|
Example
{
"edges": [PageConnectionEdge],
"nodes": [Page],
"pageInfo": PageConnectionPageInfo
}
PageConnectionEdge
Description
Edge between a Node and a connected page
Fields
| Field Name | Description |
|---|---|
cursor - String
|
Opaque reference to the nodes position in the connection. Value can be used with pagination args. |
node - Page!
|
The connected page Node |
Possible Types
| PageConnectionEdge Types |
|---|
Example
{
"cursor": "xyz789",
"node": Page
}
PageConnectionPageInfo
Description
Page Info on the connected PageConnectionEdge
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Possible Types
| PageConnectionPageInfo Types |
|---|
Example
{
"endCursor": "xyz789",
"hasNextPage": false,
"hasPreviousPage": false,
"startCursor": "xyz789"
}
PageIdType
Description
The Type of Identifier used to fetch a single resource. Default is ID.
Values
| Enum Value | Description |
|---|---|
|
|
Identify a resource by the Database ID. |
|
|
Identify a resource by the (hashed) Global ID. |
|
|
Identify a resource by the URI. |
Example
"DATABASE_ID"
PageInfo
Description
Information about pagination in a connection.
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "abc123",
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "xyz789"
}
PageModulesUnionType
Types
| Union Types |
|---|
Example
EventSearch
PageSidebarUnionType
Types
| Union Types |
|---|
Example
LayoutLinkList
PageToPreviewConnectionEdge
Description
Connection between the Page type and the page type
Example
{
"cursor": "abc123",
"node": Page
}
PageToRevisionConnection
Description
Connection between the Page type and the page type
Fields
| Field Name | Description |
|---|---|
edges - [PageToRevisionConnectionEdge!]!
|
Edges for the PageToRevisionConnection connection |
nodes - [Page!]!
|
The nodes of the connection, without the edges |
pageInfo - PageToRevisionConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [PageToRevisionConnectionEdge],
"nodes": [Page],
"pageInfo": PageToRevisionConnectionPageInfo
}
PageToRevisionConnectionEdge
PageToRevisionConnectionPageInfo
Description
Page Info on the "PageToRevisionConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "abc123",
"hasNextPage": false,
"hasPreviousPage": false,
"startCursor": "abc123"
}
PageToRevisionConnectionWhereArgs
Description
Arguments for filtering the PageToRevisionConnection connection
Fields
| Input Field | Description |
|---|---|
author - Int
|
The user that's connected as the author of the object. Use the userId for the author object. |
authorIn - [ID]
|
Find objects connected to author(s) in the array of author's userIds |
authorName - String
|
Find objects connected to the author by the author's nicename |
authorNotIn - [ID]
|
Find objects NOT connected to author(s) in the array of author's userIds |
dateQuery - DateQueryInput
|
Filter the connection based on dates |
hasPassword - Boolean
|
True for objects with passwords; False for objects without passwords; null for all objects with or without passwords |
id - Int
|
Specific database ID of the object |
in - [ID]
|
Array of IDs for the objects to retrieve |
mimeType - MimeTypeEnum
|
Get objects with a specific mimeType property |
name - String
|
Slug / post_name of the object |
nameIn - [String]
|
Specify objects to retrieve. Use slugs |
notIn - [ID]
|
Specify IDs NOT to retrieve. If this is used in the same query as "in", it will be ignored |
orderby - [PostObjectsConnectionOrderbyInput]
|
What parameter to use to order the objects by. |
parent - ID
|
Use ID to return only children. Use 0 to return only top-level items |
parentIn - [ID]
|
Specify objects whose parent is in an array |
parentNotIn - [ID]
|
Specify posts whose parent is not in an array |
password - String
|
Show posts with a specific password. |
search - String
|
Show Posts based on a keyword search |
stati - [PostStatusEnum]
|
Retrieve posts where post status is in an array. |
status - PostStatusEnum
|
Show posts with a specific status. |
title - String
|
Title of the object |
Example
{
"author": 987,
"authorIn": ["4"],
"authorName": "xyz789",
"authorNotIn": [4],
"dateQuery": DateQueryInput,
"hasPassword": false,
"id": 987,
"in": ["4"],
"mimeType": "APPLICATION_MSWORD",
"name": "xyz789",
"nameIn": ["xyz789"],
"notIn": [4],
"orderby": [PostObjectsConnectionOrderbyInput],
"parent": "4",
"parentIn": [4],
"parentNotIn": ["4"],
"password": "xyz789",
"search": "xyz789",
"stati": ["ACF_DISABLED"],
"status": "ACF_DISABLED",
"title": "abc123"
}
Plugin
Description
An plugin object
Fields
| Field Name | Description |
|---|---|
author - String
|
Name of the plugin author(s), may also be a company name. |
authorUri - String
|
URI for the related author(s)/company website. |
description - String
|
Description of the plugin. |
id - ID!
|
The globally unique identifier of the plugin object. |
isRestricted - Boolean
|
Whether the object is restricted from the current viewer |
name - String
|
Display name of the plugin. |
path - String
|
Plugin path. |
pluginUri - String
|
URI for the plugin website. This is useful for directing users for support requests etc. |
version - String
|
Current version of the plugin. |
Example
{
"author": "abc123",
"authorUri": "xyz789",
"description": "abc123",
"id": 4,
"isRestricted": false,
"name": "abc123",
"path": "abc123",
"pluginUri": "xyz789",
"version": "xyz789"
}
PluginConnection
Description
Connection to Plugin Nodes
Fields
| Field Name | Description |
|---|---|
edges - [PluginConnectionEdge!]!
|
A list of edges (relational context) between RootQuery and connected Plugin Nodes |
nodes - [Plugin!]!
|
A list of connected Plugin Nodes |
pageInfo - PluginConnectionPageInfo!
|
Information about pagination in a connection. |
Possible Types
| PluginConnection Types |
|---|
Example
{
"edges": [PluginConnectionEdge],
"nodes": [Plugin],
"pageInfo": PluginConnectionPageInfo
}
PluginConnectionEdge
Description
Edge between a Node and a connected Plugin
Fields
| Field Name | Description |
|---|---|
cursor - String
|
Opaque reference to the nodes position in the connection. Value can be used with pagination args. |
node - Plugin!
|
The connected Plugin Node |
Possible Types
| PluginConnectionEdge Types |
|---|
Example
{
"cursor": "xyz789",
"node": Plugin
}
PluginConnectionPageInfo
Description
Page Info on the connected PluginConnectionEdge
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Possible Types
| PluginConnectionPageInfo Types |
|---|
Example
{
"endCursor": "xyz789",
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "xyz789"
}
PluginStatusEnum
Description
The status of the WordPress plugin.
Values
| Enum Value | Description |
|---|---|
|
|
The plugin is currently active. |
|
|
The plugin is a drop-in plugin. |
|
|
The plugin is currently inactive. |
|
|
The plugin is a must-use plugin. |
|
|
The plugin is activated on the multisite network. |
|
|
The plugin is installed on the multisite network, but is currently inactive. |
|
|
The plugin is technically active but was paused while loading. |
|
|
The plugin was active recently. |
|
|
The plugin has an upgrade available. |
Example
"ACTIVE"
Post
Description
The post type
Fields
| Field Name | Description |
|---|---|
author - NodeWithAuthorToUserConnectionEdge
|
Connection between the NodeWithAuthor type and the User type |
authorDatabaseId - Int
|
The database identifier of the author of the node |
authorId - ID
|
The globally unique identifier of the author of the node |
breadcrumbs - [Breadcrumb]
|
Breadcrumb fields |
categories - PostToCategoryConnection
|
Connection between the Post type and the category type |
Arguments
|
|
content - String
|
The content of the post. |
Arguments
|
|
contentType - ContentNodeToContentTypeConnectionEdge
|
Connection between the ContentNode type and the ContentType type |
contentTypeName - String!
|
The name of the Content Type the node belongs to |
databaseId - Int!
|
The unique identifier stored in the database |
date - String
|
Post publishing date. |
dateGmt - String
|
The publishing date set in GMT. |
desiredSlug - String
|
The desired slug of the post |
editingLockedBy - ContentNodeToEditLockConnectionEdge
|
If a user has edited the node within the past 15 seconds, this will return the user that last edited. Null if the edit lock doesn't exist or is greater than 15 seconds |
enclosure - String
|
The RSS enclosure for the object |
enqueuedScripts - ContentNodeToEnqueuedScriptConnection
|
Connection between the ContentNode type and the EnqueuedScript type |
Arguments
|
|
enqueuedStylesheets - ContentNodeToEnqueuedStylesheetConnection
|
Connection between the ContentNode type and the EnqueuedStylesheet type |
Arguments
|
|
expirationTime - String
|
Vanhentumisaika |
featuredImage - NodeWithFeaturedImageToMediaItemConnectionEdge
|
Connection between the NodeWithFeaturedImage type and the MediaItem type |
featuredImageDatabaseId - Int
|
The database identifier for the featured image node assigned to the content node |
featuredImageId - ID
|
Globally unique ID of the featured image assigned to the node |
guid - String
|
The global unique identifier for this post. This currently matches the value stored in WP_Post->guid and the guid column in the "post_objects" database table. |
hidePublishedDate - Boolean
|
Hide Published Date |
id - ID!
|
The globally unique identifier of the post object. |
isComment - Boolean!
|
Whether the node is a Comment |
isContentNode - Boolean!
|
Whether the node is a Content Node |
isFrontPage - Boolean!
|
Whether the node represents the front page. |
isPostsPage - Boolean!
|
Whether the node represents the blog page. |
isPreview - Boolean
|
Whether the object is a node in the preview state |
isRestricted - Boolean
|
Whether the object is restricted from the current viewer |
isRevision - Boolean
|
True if the node is a revision of another node |
isSticky - Boolean!
|
Whether this page is sticky |
isTermNode - Boolean!
|
Whether the node is a Term |
language - Language
|
Polylang language |
lastEditedBy - ContentNodeToEditLastConnectionEdge
|
The user that most recently edited the node |
lead - String
|
Ingressi |
link - String
|
The permalink of the post |
modified - String
|
The local modified time for a post. If a post was recently updated the modified field will change to match the corresponding time. |
modifiedGmt - String
|
The GMT modified time for a post. If a post was recently updated the modified field will change to match the corresponding time in GMT. |
modules - [PostModulesUnionType]
|
List of modules |
postFormats - PostToPostFormatConnection
|
Connection between the Post type and the postFormat type |
Arguments
|
|
postId - Int!
|
The id field matches the WP_Post->ID field. Deprecated in favor of the databaseId field |
preview - PostToPreviewConnectionEdge
|
Connection between the Post type and the post type |
previewRevisionDatabaseId - Int
|
The database id of the preview node |
previewRevisionId - ID
|
Whether the object is a node in the preview state |
revisionOf - NodeWithRevisionsToContentNodeConnectionEdge
|
If the current node is a revision, this field exposes the node this is a revision of. Returns null if the node is not a revision of another node. |
revisions - PostToRevisionConnection
|
Connection between the Post type and the post type |
Arguments
|
|
seo - SEO
|
The SEO Framework data of the post |
sidebar - [PostSidebarUnionType]
|
List of modules |
slug - String
|
The uri slug for the post. This is equivalent to the WP_Post->post_name field and the post_name column in the database for the "post_objects" table. |
status - String
|
The current status of the object |
tags - PostToTagConnection
|
Connection between the Post type and the tag type |
Arguments
|
|
template - ContentTemplate
|
The template assigned to the node |
terms - PostToTermNodeConnection
|
Connection between the Post type and the TermNode type |
Arguments
|
|
title - String
|
The title of the post. This is currently just the raw title. An amendment to support rendered title needs to be made. |
Arguments
|
|
translation - Post
|
Get specific translation version of this object |
Arguments
|
|
translations - [Post]
|
List all translated versions of this post |
uri - String
|
The unique resource identifier path |
Example
{
"author": NodeWithAuthorToUserConnectionEdge,
"authorDatabaseId": 123,
"authorId": "4",
"breadcrumbs": [Breadcrumb],
"categories": PostToCategoryConnection,
"content": "abc123",
"contentType": ContentNodeToContentTypeConnectionEdge,
"contentTypeName": "abc123",
"databaseId": 123,
"date": "abc123",
"dateGmt": "xyz789",
"desiredSlug": "xyz789",
"editingLockedBy": ContentNodeToEditLockConnectionEdge,
"enclosure": "xyz789",
"enqueuedScripts": ContentNodeToEnqueuedScriptConnection,
"enqueuedStylesheets": ContentNodeToEnqueuedStylesheetConnection,
"expirationTime": "xyz789",
"featuredImage": NodeWithFeaturedImageToMediaItemConnectionEdge,
"featuredImageDatabaseId": 123,
"featuredImageId": 4,
"guid": "xyz789",
"hidePublishedDate": false,
"id": "4",
"isComment": true,
"isContentNode": false,
"isFrontPage": false,
"isPostsPage": true,
"isPreview": false,
"isRestricted": false,
"isRevision": true,
"isSticky": true,
"isTermNode": false,
"language": Language,
"lastEditedBy": ContentNodeToEditLastConnectionEdge,
"lead": "abc123",
"link": "xyz789",
"modified": "xyz789",
"modifiedGmt": "abc123",
"modules": [EventSearch],
"postFormats": PostToPostFormatConnection,
"postId": 987,
"preview": PostToPreviewConnectionEdge,
"previewRevisionDatabaseId": 123,
"previewRevisionId": "4",
"revisionOf": NodeWithRevisionsToContentNodeConnectionEdge,
"revisions": PostToRevisionConnection,
"seo": SEO,
"sidebar": [LayoutLinkList],
"slug": "xyz789",
"status": "abc123",
"tags": PostToTagConnection,
"template": ContentTemplate,
"terms": PostToTermNodeConnection,
"title": "abc123",
"translation": Post,
"translations": [Post],
"uri": "abc123"
}
PostCategoriesInput
Description
Set relationships between the post to categories
Fields
| Input Field | Description |
|---|---|
append - Boolean
|
If true, this will append the category to existing related categories. If false, this will replace existing relationships. Default true. |
nodes - [PostCategoriesNodeInput]
|
The input list of items to set. |
Example
{"append": true, "nodes": [PostCategoriesNodeInput]}
PostCategoriesNodeInput
Description
List of categories to connect the post to. If an ID is set, it will be used to create the connection. If not, it will look for a slug. If neither are valid existing terms, and the site is configured to allow terms to be created during post mutations, a term will be created using the Name if it exists in the input, then fallback to the slug if it exists.
Fields
| Input Field | Description |
|---|---|
description - String
|
The description of the category. This field is used to set a description of the category if a new one is created during the mutation. |
id - ID
|
The ID of the category. If present, this will be used to connect to the post. If no existing category exists with this ID, no connection will be made. |
name - String
|
The name of the category. This field is used to create a new term, if term creation is enabled in nested mutations, and if one does not already exist with the provided slug or ID or if a slug or ID is not provided. If no name is included and a term is created, the creation will fallback to the slug field. |
slug - String
|
The slug of the category. If no ID is present, this field will be used to make a connection. If no existing term exists with this slug, this field will be used as a fallback to the Name field when creating a new term to connect to, if term creation is enabled as a nested mutation. |
Example
{
"description": "xyz789",
"id": 4,
"name": "xyz789",
"slug": "abc123"
}
PostConnection
Description
Connection to post Nodes
Fields
| Field Name | Description |
|---|---|
edges - [PostConnectionEdge!]!
|
A list of edges (relational context) between RootQuery and connected post Nodes |
nodes - [Post!]!
|
A list of connected post Nodes |
pageInfo - PostConnectionPageInfo!
|
Information about pagination in a connection. |
Possible Types
| PostConnection Types |
|---|
Example
{
"edges": [PostConnectionEdge],
"nodes": [Post],
"pageInfo": PostConnectionPageInfo
}
PostConnectionEdge
PostConnectionPageInfo
Description
Page Info on the connected PostConnectionEdge
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Possible Types
| PostConnectionPageInfo Types |
|---|
Example
{
"endCursor": "abc123",
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "abc123"
}
PostFormat
Description
The postFormat type
Fields
| Field Name | Description |
|---|---|
contentNodes - PostFormatToContentNodeConnection
|
Connection between the PostFormat type and the ContentNode type |
Arguments
|
|
count - Int
|
The number of objects connected to the object |
databaseId - Int!
|
The unique identifier stored in the database |
description - String
|
The description of the object |
enqueuedScripts - TermNodeToEnqueuedScriptConnection
|
Connection between the TermNode type and the EnqueuedScript type |
Arguments
|
|
enqueuedStylesheets - TermNodeToEnqueuedStylesheetConnection
|
Connection between the TermNode type and the EnqueuedStylesheet type |
Arguments
|
|
id - ID!
|
The globally unique ID for the object |
isComment - Boolean!
|
Whether the node is a Comment |
isContentNode - Boolean!
|
Whether the node is a Content Node |
isFrontPage - Boolean!
|
Whether the node represents the front page. |
isPostsPage - Boolean!
|
Whether the node represents the blog page. |
isRestricted - Boolean
|
Whether the object is restricted from the current viewer |
isTermNode - Boolean!
|
Whether the node is a Term |
link - String
|
The link to the term |
name - String
|
The human friendly name of the object. |
postFormatId - Int
|
The id field matches the WP_Post->ID field. Deprecated in favor of databaseId |
posts - PostFormatToPostConnection
|
Connection between the PostFormat type and the post type |
Arguments
|
|
slug - String
|
An alphanumeric identifier for the object unique to its type. |
taxonomy - PostFormatToTaxonomyConnectionEdge
|
Connection between the PostFormat type and the Taxonomy type |
taxonomyName - String
|
The name of the taxonomy that the object is associated with |
termGroupId - Int
|
The ID of the term group that this term object belongs to |
termTaxonomyId - Int
|
The taxonomy ID that the object is associated with |
uri - String
|
The unique resource identifier path |
Example
{
"contentNodes": PostFormatToContentNodeConnection,
"count": 123,
"databaseId": 987,
"description": "xyz789",
"enqueuedScripts": TermNodeToEnqueuedScriptConnection,
"enqueuedStylesheets": TermNodeToEnqueuedStylesheetConnection,
"id": 4,
"isComment": true,
"isContentNode": false,
"isFrontPage": false,
"isPostsPage": false,
"isRestricted": true,
"isTermNode": true,
"link": "xyz789",
"name": "xyz789",
"postFormatId": 123,
"posts": PostFormatToPostConnection,
"slug": "xyz789",
"taxonomy": PostFormatToTaxonomyConnectionEdge,
"taxonomyName": "abc123",
"termGroupId": 123,
"termTaxonomyId": 123,
"uri": "xyz789"
}
PostFormatConnection
Description
Connection to postFormat Nodes
Fields
| Field Name | Description |
|---|---|
edges - [PostFormatConnectionEdge!]!
|
A list of edges (relational context) between RootQuery and connected postFormat Nodes |
nodes - [PostFormat!]!
|
A list of connected postFormat Nodes |
pageInfo - PostFormatConnectionPageInfo!
|
Information about pagination in a connection. |
Possible Types
| PostFormatConnection Types |
|---|
Example
{
"edges": [PostFormatConnectionEdge],
"nodes": [PostFormat],
"pageInfo": PostFormatConnectionPageInfo
}
PostFormatConnectionEdge
Description
Edge between a Node and a connected postFormat
Fields
| Field Name | Description |
|---|---|
cursor - String
|
Opaque reference to the nodes position in the connection. Value can be used with pagination args. |
node - PostFormat!
|
The connected postFormat Node |
Possible Types
| PostFormatConnectionEdge Types |
|---|
Example
{
"cursor": "abc123",
"node": PostFormat
}
PostFormatConnectionPageInfo
Description
Page Info on the connected PostFormatConnectionEdge
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Possible Types
| PostFormatConnectionPageInfo Types |
|---|
Example
{
"endCursor": "xyz789",
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "abc123"
}
PostFormatIdType
Description
The Type of Identifier used to fetch a single resource. Default is ID.
Values
| Enum Value | Description |
|---|---|
|
|
The Database ID for the node |
|
|
The hashed Global ID |
|
|
The name of the node |
|
|
Url friendly name of the node |
|
|
The URI for the node |
Example
"DATABASE_ID"
PostFormatToContentNodeConnection
Description
Connection between the PostFormat type and the ContentNode type
Fields
| Field Name | Description |
|---|---|
edges - [PostFormatToContentNodeConnectionEdge!]!
|
Edges for the PostFormatToContentNodeConnection connection |
nodes - [ContentNode!]!
|
The nodes of the connection, without the edges |
pageInfo - PostFormatToContentNodeConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [PostFormatToContentNodeConnectionEdge],
"nodes": [ContentNode],
"pageInfo": PostFormatToContentNodeConnectionPageInfo
}
PostFormatToContentNodeConnectionEdge
Description
An edge in a connection
Fields
| Field Name | Description |
|---|---|
cursor - String
|
A cursor for use in pagination |
node - ContentNode!
|
The item at the end of the edge |
Example
{
"cursor": "xyz789",
"node": ContentNode
}
PostFormatToContentNodeConnectionPageInfo
Description
Page Info on the "PostFormatToContentNodeConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "xyz789",
"hasNextPage": false,
"hasPreviousPage": true,
"startCursor": "xyz789"
}
PostFormatToContentNodeConnectionWhereArgs
Description
Arguments for filtering the PostFormatToContentNodeConnection connection
Fields
| Input Field | Description |
|---|---|
contentTypes - [ContentTypesOfPostFormatEnum]
|
The Types of content to filter |
dateQuery - DateQueryInput
|
Filter the connection based on dates |
hasPassword - Boolean
|
True for objects with passwords; False for objects without passwords; null for all objects with or without passwords |
id - Int
|
Specific database ID of the object |
in - [ID]
|
Array of IDs for the objects to retrieve |
mimeType - MimeTypeEnum
|
Get objects with a specific mimeType property |
name - String
|
Slug / post_name of the object |
nameIn - [String]
|
Specify objects to retrieve. Use slugs |
notIn - [ID]
|
Specify IDs NOT to retrieve. If this is used in the same query as "in", it will be ignored |
orderby - [PostObjectsConnectionOrderbyInput]
|
What parameter to use to order the objects by. |
parent - ID
|
Use ID to return only children. Use 0 to return only top-level items |
parentIn - [ID]
|
Specify objects whose parent is in an array |
parentNotIn - [ID]
|
Specify posts whose parent is not in an array |
password - String
|
Show posts with a specific password. |
search - String
|
Show Posts based on a keyword search |
stati - [PostStatusEnum]
|
Retrieve posts where post status is in an array. |
status - PostStatusEnum
|
Show posts with a specific status. |
title - String
|
Title of the object |
Example
{
"contentTypes": ["POST"],
"dateQuery": DateQueryInput,
"hasPassword": true,
"id": 987,
"in": ["4"],
"mimeType": "APPLICATION_MSWORD",
"name": "abc123",
"nameIn": ["abc123"],
"notIn": ["4"],
"orderby": [PostObjectsConnectionOrderbyInput],
"parent": "4",
"parentIn": [4],
"parentNotIn": [4],
"password": "abc123",
"search": "abc123",
"stati": ["ACF_DISABLED"],
"status": "ACF_DISABLED",
"title": "xyz789"
}
PostFormatToPostConnection
Description
Connection between the PostFormat type and the post type
Fields
| Field Name | Description |
|---|---|
edges - [PostFormatToPostConnectionEdge!]!
|
Edges for the PostFormatToPostConnection connection |
nodes - [Post!]!
|
The nodes of the connection, without the edges |
pageInfo - PostFormatToPostConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [PostFormatToPostConnectionEdge],
"nodes": [Post],
"pageInfo": PostFormatToPostConnectionPageInfo
}
PostFormatToPostConnectionEdge
PostFormatToPostConnectionPageInfo
Description
Page Info on the "PostFormatToPostConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "xyz789",
"hasNextPage": false,
"hasPreviousPage": true,
"startCursor": "xyz789"
}
PostFormatToPostConnectionWhereArgs
Description
Arguments for filtering the PostFormatToPostConnection connection
Fields
| Input Field | Description |
|---|---|
author - Int
|
The user that's connected as the author of the object. Use the userId for the author object. |
authorIn - [ID]
|
Find objects connected to author(s) in the array of author's userIds |
authorName - String
|
Find objects connected to the author by the author's nicename |
authorNotIn - [ID]
|
Find objects NOT connected to author(s) in the array of author's userIds |
categoryId - Int
|
Category ID |
categoryIn - [ID]
|
Array of category IDs, used to display objects from one category OR another |
categoryName - String
|
Use Category Slug |
categoryNotIn - [ID]
|
Array of category IDs, used to display objects from one category OR another |
dateQuery - DateQueryInput
|
Filter the connection based on dates |
hasPassword - Boolean
|
True for objects with passwords; False for objects without passwords; null for all objects with or without passwords |
id - Int
|
Specific database ID of the object |
in - [ID]
|
Array of IDs for the objects to retrieve |
mimeType - MimeTypeEnum
|
Get objects with a specific mimeType property |
name - String
|
Slug / post_name of the object |
nameIn - [String]
|
Specify objects to retrieve. Use slugs |
notIn - [ID]
|
Specify IDs NOT to retrieve. If this is used in the same query as "in", it will be ignored |
orderby - [PostObjectsConnectionOrderbyInput]
|
What parameter to use to order the objects by. |
parent - ID
|
Use ID to return only children. Use 0 to return only top-level items |
parentIn - [ID]
|
Specify objects whose parent is in an array |
parentNotIn - [ID]
|
Specify posts whose parent is not in an array |
password - String
|
Show posts with a specific password. |
search - String
|
Show Posts based on a keyword search |
stati - [PostStatusEnum]
|
Retrieve posts where post status is in an array. |
status - PostStatusEnum
|
Show posts with a specific status. |
tag - String
|
Tag Slug |
tagId - String
|
Use Tag ID |
tagIn - [ID]
|
Array of tag IDs, used to display objects from one tag OR another |
tagNotIn - [ID]
|
Array of tag IDs, used to display objects from one tag OR another |
tagSlugAnd - [String]
|
Array of tag slugs, used to display objects from one tag AND another |
tagSlugIn - [String]
|
Array of tag slugs, used to include objects in ANY specified tags |
title - String
|
Title of the object |
Example
{
"author": 123,
"authorIn": [4],
"authorName": "abc123",
"authorNotIn": [4],
"categoryId": 987,
"categoryIn": [4],
"categoryName": "abc123",
"categoryNotIn": ["4"],
"dateQuery": DateQueryInput,
"hasPassword": true,
"id": 987,
"in": ["4"],
"mimeType": "APPLICATION_MSWORD",
"name": "xyz789",
"nameIn": ["abc123"],
"notIn": [4],
"orderby": [PostObjectsConnectionOrderbyInput],
"parent": 4,
"parentIn": [4],
"parentNotIn": ["4"],
"password": "abc123",
"search": "abc123",
"stati": ["ACF_DISABLED"],
"status": "ACF_DISABLED",
"tag": "abc123",
"tagId": "abc123",
"tagIn": [4],
"tagNotIn": ["4"],
"tagSlugAnd": ["abc123"],
"tagSlugIn": ["xyz789"],
"title": "abc123"
}
PostFormatToTaxonomyConnectionEdge
Description
Connection between the PostFormat type and the Taxonomy type
Example
{
"cursor": "xyz789",
"node": Taxonomy
}
PostIdType
Description
The Type of Identifier used to fetch a single resource. Default is ID.
Values
| Enum Value | Description |
|---|---|
|
|
Identify a resource by the Database ID. |
|
|
Identify a resource by the (hashed) Global ID. |
|
|
Identify a resource by the slug. Available to non-hierarchcial Types where the slug is a unique identifier. |
|
|
Identify a resource by the URI. |
Example
"DATABASE_ID"
PostModulesUnionType
Types
| Union Types |
|---|
Example
EventSearch
PostObjectFieldFormatEnum
Description
The format of post field data.
Values
| Enum Value | Description |
|---|---|
|
|
Provide the field value directly from database. Null on unauthenticated requests. |
|
|
Provide the field value as rendered by WordPress. Default. |
Example
"RAW"
PostObjectsConnectionDateColumnEnum
Description
The column to use when filtering by date
Values
| Enum Value | Description |
|---|---|
|
|
The date the comment was created in local time. |
|
|
The most recent modification date of the comment. |
Example
"DATE"
PostObjectsConnectionOrderbyEnum
Description
Field to order the connection by
Values
| Enum Value | Description |
|---|---|
|
|
Order by author |
|
|
Order by the number of comments it has acquired |
|
|
Order by publish date |
|
|
Preserve the ID order given in the IN array |
|
|
Order by the menu order value |
|
|
Order by last modified date |
|
|
Preserve slug order given in the NAME_IN array |
|
|
Order by parent ID |
|
|
Order by slug |
|
|
Order by title |
Example
"AUTHOR"
PostObjectsConnectionOrderbyInput
Description
Options for ordering the connection
Fields
| Input Field | Description |
|---|---|
field - PostObjectsConnectionOrderbyEnum!
|
The field to order the connection by |
order - OrderEnum!
|
Possible directions in which to order a list of items |
Example
{"field": "AUTHOR", "order": "ASC"}
PostPostFormatsInput
Description
Set relationships between the post to postFormats
Fields
| Input Field | Description |
|---|---|
append - Boolean
|
If true, this will append the postFormat to existing related postFormats. If false, this will replace existing relationships. Default true. |
nodes - [PostPostFormatsNodeInput]
|
The input list of items to set. |
Example
{"append": true, "nodes": [PostPostFormatsNodeInput]}
PostPostFormatsNodeInput
Description
List of postFormats to connect the post to. If an ID is set, it will be used to create the connection. If not, it will look for a slug. If neither are valid existing terms, and the site is configured to allow terms to be created during post mutations, a term will be created using the Name if it exists in the input, then fallback to the slug if it exists.
Fields
| Input Field | Description |
|---|---|
description - String
|
The description of the postFormat. This field is used to set a description of the postFormat if a new one is created during the mutation. |
id - ID
|
The ID of the postFormat. If present, this will be used to connect to the post. If no existing postFormat exists with this ID, no connection will be made. |
name - String
|
The name of the postFormat. This field is used to create a new term, if term creation is enabled in nested mutations, and if one does not already exist with the provided slug or ID or if a slug or ID is not provided. If no name is included and a term is created, the creation will fallback to the slug field. |
slug - String
|
The slug of the postFormat. If no ID is present, this field will be used to make a connection. If no existing term exists with this slug, this field will be used as a fallback to the Name field when creating a new term to connect to, if term creation is enabled as a nested mutation. |
Example
{
"description": "abc123",
"id": 4,
"name": "abc123",
"slug": "abc123"
}
PostSidebarUnionType
Types
| Union Types |
|---|
Example
LayoutLinkList
PostStatusEnum
Description
The status of the object.
Values
| Enum Value | Description |
|---|---|
|
|
Objects with the acf-disabled status |
|
|
Objects with the auto-draft status |
|
|
Objects with the dp-rewrite-republish status |
|
|
Objects with the draft status |
|
|
Objects with the future status |
|
|
Objects with the inherit status |
|
|
Objects with the pending status |
|
|
Objects with the private status |
|
|
Objects with the publish status |
|
|
Objects with the request-completed status |
|
|
Objects with the request-confirmed status |
|
|
Objects with the request-failed status |
|
|
Objects with the request-pending status |
|
|
Objects with the trash status |
|
|
Objects with the wp_stream_disabled status |
|
|
Objects with the wp_stream_enabled status |
Example
"ACF_DISABLED"
PostTagsInput
Description
Set relationships between the post to tags
Fields
| Input Field | Description |
|---|---|
append - Boolean
|
If true, this will append the tag to existing related tags. If false, this will replace existing relationships. Default true. |
nodes - [PostTagsNodeInput]
|
The input list of items to set. |
Example
{"append": false, "nodes": [PostTagsNodeInput]}
PostTagsNodeInput
Description
List of tags to connect the post to. If an ID is set, it will be used to create the connection. If not, it will look for a slug. If neither are valid existing terms, and the site is configured to allow terms to be created during post mutations, a term will be created using the Name if it exists in the input, then fallback to the slug if it exists.
Fields
| Input Field | Description |
|---|---|
description - String
|
The description of the tag. This field is used to set a description of the tag if a new one is created during the mutation. |
id - ID
|
The ID of the tag. If present, this will be used to connect to the post. If no existing tag exists with this ID, no connection will be made. |
name - String
|
The name of the tag. This field is used to create a new term, if term creation is enabled in nested mutations, and if one does not already exist with the provided slug or ID or if a slug or ID is not provided. If no name is included and a term is created, the creation will fallback to the slug field. |
slug - String
|
The slug of the tag. If no ID is present, this field will be used to make a connection. If no existing term exists with this slug, this field will be used as a fallback to the Name field when creating a new term to connect to, if term creation is enabled as a nested mutation. |
Example
{
"description": "abc123",
"id": "4",
"name": "xyz789",
"slug": "abc123"
}
PostToCategoryConnection
Description
Connection between the Post type and the category type
Fields
| Field Name | Description |
|---|---|
edges - [PostToCategoryConnectionEdge!]!
|
Edges for the PostToCategoryConnection connection |
nodes - [Category!]!
|
The nodes of the connection, without the edges |
pageInfo - PostToCategoryConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [PostToCategoryConnectionEdge],
"nodes": [Category],
"pageInfo": PostToCategoryConnectionPageInfo
}
PostToCategoryConnectionEdge
PostToCategoryConnectionPageInfo
Description
Page Info on the "PostToCategoryConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "abc123",
"hasNextPage": true,
"hasPreviousPage": false,
"startCursor": "xyz789"
}
PostToCategoryConnectionWhereArgs
Description
Arguments for filtering the PostToCategoryConnection connection
Fields
| Input Field | Description |
|---|---|
cacheDomain - String
|
Unique cache key to be produced when this query is stored in an object cache. Default is 'core'. |
childOf - Int
|
Term ID to retrieve child terms of. If multiple taxonomies are passed, $child_of is ignored. Default 0. |
childless - Boolean
|
True to limit results to terms that have no children. This parameter has no effect on non-hierarchical taxonomies. Default false. |
descriptionLike - String
|
Retrieve terms where the description is LIKE the input value. Default empty. |
exclude - [ID]
|
Array of term ids to exclude. If $include is non-empty, $exclude is ignored. Default empty array. |
excludeTree - [ID]
|
Array of term ids to exclude along with all of their descendant terms. If $include is non-empty, $exclude_tree is ignored. Default empty array. |
hideEmpty - Boolean
|
Whether to hide terms not assigned to any posts. Accepts true or false. Default false |
hierarchical - Boolean
|
Whether to include terms that have non-empty descendants (even if $hide_empty is set to true). Default true. |
include - [ID]
|
Array of term ids to include. Default empty array. |
name - [String]
|
Array of names to return term(s) for. Default empty. |
nameLike - String
|
Retrieve terms where the name is LIKE the input value. Default empty. |
objectIds - [ID]
|
Array of object IDs. Results will be limited to terms associated with these objects. |
order - OrderEnum
|
Direction the connection should be ordered in |
orderby - TermObjectsConnectionOrderbyEnum
|
Field(s) to order terms by. Defaults to 'name'. |
padCounts - Boolean
|
Whether to pad the quantity of a term's children in the quantity of each term's "count" object variable. Default false. |
parent - Int
|
Parent term ID to retrieve direct-child terms of. Default empty. |
search - String
|
Search criteria to match terms. Will be SQL-formatted with wildcards before and after. Default empty. |
slug - [String]
|
Array of slugs to return term(s) for. Default empty. |
termTaxonomId - [ID]
|
Array of term taxonomy IDs, to match when querying terms. |
termTaxonomyId - [ID]
|
Array of term taxonomy IDs, to match when querying terms. |
updateTermMetaCache - Boolean
|
Whether to prime meta caches for matched terms. Default true. |
Example
{
"cacheDomain": "abc123",
"childOf": 987,
"childless": false,
"descriptionLike": "abc123",
"exclude": [4],
"excludeTree": [4],
"hideEmpty": true,
"hierarchical": false,
"include": ["4"],
"name": ["abc123"],
"nameLike": "xyz789",
"objectIds": [4],
"order": "ASC",
"orderby": "COUNT",
"padCounts": false,
"parent": 987,
"search": "abc123",
"slug": ["xyz789"],
"termTaxonomId": ["4"],
"termTaxonomyId": ["4"],
"updateTermMetaCache": false
}
PostToPostFormatConnection
Description
Connection between the Post type and the postFormat type
Fields
| Field Name | Description |
|---|---|
edges - [PostToPostFormatConnectionEdge!]!
|
Edges for the PostToPostFormatConnection connection |
nodes - [PostFormat!]!
|
The nodes of the connection, without the edges |
pageInfo - PostToPostFormatConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [PostToPostFormatConnectionEdge],
"nodes": [PostFormat],
"pageInfo": PostToPostFormatConnectionPageInfo
}
PostToPostFormatConnectionEdge
Description
An edge in a connection
Fields
| Field Name | Description |
|---|---|
cursor - String
|
A cursor for use in pagination |
node - PostFormat!
|
The item at the end of the edge |
Example
{
"cursor": "abc123",
"node": PostFormat
}
PostToPostFormatConnectionPageInfo
Description
Page Info on the "PostToPostFormatConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "xyz789",
"hasNextPage": false,
"hasPreviousPage": false,
"startCursor": "abc123"
}
PostToPostFormatConnectionWhereArgs
Description
Arguments for filtering the PostToPostFormatConnection connection
Fields
| Input Field | Description |
|---|---|
cacheDomain - String
|
Unique cache key to be produced when this query is stored in an object cache. Default is 'core'. |
childOf - Int
|
Term ID to retrieve child terms of. If multiple taxonomies are passed, $child_of is ignored. Default 0. |
childless - Boolean
|
True to limit results to terms that have no children. This parameter has no effect on non-hierarchical taxonomies. Default false. |
descriptionLike - String
|
Retrieve terms where the description is LIKE the input value. Default empty. |
exclude - [ID]
|
Array of term ids to exclude. If $include is non-empty, $exclude is ignored. Default empty array. |
excludeTree - [ID]
|
Array of term ids to exclude along with all of their descendant terms. If $include is non-empty, $exclude_tree is ignored. Default empty array. |
hideEmpty - Boolean
|
Whether to hide terms not assigned to any posts. Accepts true or false. Default false |
hierarchical - Boolean
|
Whether to include terms that have non-empty descendants (even if $hide_empty is set to true). Default true. |
include - [ID]
|
Array of term ids to include. Default empty array. |
name - [String]
|
Array of names to return term(s) for. Default empty. |
nameLike - String
|
Retrieve terms where the name is LIKE the input value. Default empty. |
objectIds - [ID]
|
Array of object IDs. Results will be limited to terms associated with these objects. |
order - OrderEnum
|
Direction the connection should be ordered in |
orderby - TermObjectsConnectionOrderbyEnum
|
Field(s) to order terms by. Defaults to 'name'. |
padCounts - Boolean
|
Whether to pad the quantity of a term's children in the quantity of each term's "count" object variable. Default false. |
parent - Int
|
Parent term ID to retrieve direct-child terms of. Default empty. |
search - String
|
Search criteria to match terms. Will be SQL-formatted with wildcards before and after. Default empty. |
slug - [String]
|
Array of slugs to return term(s) for. Default empty. |
termTaxonomId - [ID]
|
Array of term taxonomy IDs, to match when querying terms. |
termTaxonomyId - [ID]
|
Array of term taxonomy IDs, to match when querying terms. |
updateTermMetaCache - Boolean
|
Whether to prime meta caches for matched terms. Default true. |
Example
{
"cacheDomain": "xyz789",
"childOf": 123,
"childless": true,
"descriptionLike": "abc123",
"exclude": ["4"],
"excludeTree": ["4"],
"hideEmpty": false,
"hierarchical": true,
"include": [4],
"name": ["xyz789"],
"nameLike": "xyz789",
"objectIds": [4],
"order": "ASC",
"orderby": "COUNT",
"padCounts": true,
"parent": 123,
"search": "xyz789",
"slug": ["abc123"],
"termTaxonomId": ["4"],
"termTaxonomyId": ["4"],
"updateTermMetaCache": false
}
PostToPreviewConnectionEdge
Description
Connection between the Post type and the post type
Example
{
"cursor": "xyz789",
"node": Post
}
PostToRevisionConnection
Description
Connection between the Post type and the post type
Fields
| Field Name | Description |
|---|---|
edges - [PostToRevisionConnectionEdge!]!
|
Edges for the PostToRevisionConnection connection |
nodes - [Post!]!
|
The nodes of the connection, without the edges |
pageInfo - PostToRevisionConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [PostToRevisionConnectionEdge],
"nodes": [Post],
"pageInfo": PostToRevisionConnectionPageInfo
}
PostToRevisionConnectionEdge
PostToRevisionConnectionPageInfo
Description
Page Info on the "PostToRevisionConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "xyz789",
"hasNextPage": true,
"hasPreviousPage": false,
"startCursor": "xyz789"
}
PostToRevisionConnectionWhereArgs
Description
Arguments for filtering the PostToRevisionConnection connection
Fields
| Input Field | Description |
|---|---|
author - Int
|
The user that's connected as the author of the object. Use the userId for the author object. |
authorIn - [ID]
|
Find objects connected to author(s) in the array of author's userIds |
authorName - String
|
Find objects connected to the author by the author's nicename |
authorNotIn - [ID]
|
Find objects NOT connected to author(s) in the array of author's userIds |
categoryId - Int
|
Category ID |
categoryIn - [ID]
|
Array of category IDs, used to display objects from one category OR another |
categoryName - String
|
Use Category Slug |
categoryNotIn - [ID]
|
Array of category IDs, used to display objects from one category OR another |
dateQuery - DateQueryInput
|
Filter the connection based on dates |
hasPassword - Boolean
|
True for objects with passwords; False for objects without passwords; null for all objects with or without passwords |
id - Int
|
Specific database ID of the object |
in - [ID]
|
Array of IDs for the objects to retrieve |
mimeType - MimeTypeEnum
|
Get objects with a specific mimeType property |
name - String
|
Slug / post_name of the object |
nameIn - [String]
|
Specify objects to retrieve. Use slugs |
notIn - [ID]
|
Specify IDs NOT to retrieve. If this is used in the same query as "in", it will be ignored |
orderby - [PostObjectsConnectionOrderbyInput]
|
What parameter to use to order the objects by. |
parent - ID
|
Use ID to return only children. Use 0 to return only top-level items |
parentIn - [ID]
|
Specify objects whose parent is in an array |
parentNotIn - [ID]
|
Specify posts whose parent is not in an array |
password - String
|
Show posts with a specific password. |
search - String
|
Show Posts based on a keyword search |
stati - [PostStatusEnum]
|
Retrieve posts where post status is in an array. |
status - PostStatusEnum
|
Show posts with a specific status. |
tag - String
|
Tag Slug |
tagId - String
|
Use Tag ID |
tagIn - [ID]
|
Array of tag IDs, used to display objects from one tag OR another |
tagNotIn - [ID]
|
Array of tag IDs, used to display objects from one tag OR another |
tagSlugAnd - [String]
|
Array of tag slugs, used to display objects from one tag AND another |
tagSlugIn - [String]
|
Array of tag slugs, used to include objects in ANY specified tags |
title - String
|
Title of the object |
Example
{
"author": 123,
"authorIn": [4],
"authorName": "abc123",
"authorNotIn": ["4"],
"categoryId": 123,
"categoryIn": [4],
"categoryName": "xyz789",
"categoryNotIn": [4],
"dateQuery": DateQueryInput,
"hasPassword": false,
"id": 987,
"in": [4],
"mimeType": "APPLICATION_MSWORD",
"name": "xyz789",
"nameIn": ["abc123"],
"notIn": ["4"],
"orderby": [PostObjectsConnectionOrderbyInput],
"parent": "4",
"parentIn": [4],
"parentNotIn": [4],
"password": "abc123",
"search": "abc123",
"stati": ["ACF_DISABLED"],
"status": "ACF_DISABLED",
"tag": "abc123",
"tagId": "abc123",
"tagIn": [4],
"tagNotIn": ["4"],
"tagSlugAnd": ["xyz789"],
"tagSlugIn": ["abc123"],
"title": "abc123"
}
PostToTagConnection
Description
Connection between the Post type and the tag type
Fields
| Field Name | Description |
|---|---|
edges - [PostToTagConnectionEdge!]!
|
Edges for the PostToTagConnection connection |
nodes - [Tag!]!
|
The nodes of the connection, without the edges |
pageInfo - PostToTagConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [PostToTagConnectionEdge],
"nodes": [Tag],
"pageInfo": PostToTagConnectionPageInfo
}
PostToTagConnectionEdge
PostToTagConnectionPageInfo
Description
Page Info on the "PostToTagConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "xyz789",
"hasNextPage": true,
"hasPreviousPage": false,
"startCursor": "abc123"
}
PostToTagConnectionWhereArgs
Description
Arguments for filtering the PostToTagConnection connection
Fields
| Input Field | Description |
|---|---|
cacheDomain - String
|
Unique cache key to be produced when this query is stored in an object cache. Default is 'core'. |
childOf - Int
|
Term ID to retrieve child terms of. If multiple taxonomies are passed, $child_of is ignored. Default 0. |
childless - Boolean
|
True to limit results to terms that have no children. This parameter has no effect on non-hierarchical taxonomies. Default false. |
descriptionLike - String
|
Retrieve terms where the description is LIKE the input value. Default empty. |
exclude - [ID]
|
Array of term ids to exclude. If $include is non-empty, $exclude is ignored. Default empty array. |
excludeTree - [ID]
|
Array of term ids to exclude along with all of their descendant terms. If $include is non-empty, $exclude_tree is ignored. Default empty array. |
hideEmpty - Boolean
|
Whether to hide terms not assigned to any posts. Accepts true or false. Default false |
hierarchical - Boolean
|
Whether to include terms that have non-empty descendants (even if $hide_empty is set to true). Default true. |
include - [ID]
|
Array of term ids to include. Default empty array. |
name - [String]
|
Array of names to return term(s) for. Default empty. |
nameLike - String
|
Retrieve terms where the name is LIKE the input value. Default empty. |
objectIds - [ID]
|
Array of object IDs. Results will be limited to terms associated with these objects. |
order - OrderEnum
|
Direction the connection should be ordered in |
orderby - TermObjectsConnectionOrderbyEnum
|
Field(s) to order terms by. Defaults to 'name'. |
padCounts - Boolean
|
Whether to pad the quantity of a term's children in the quantity of each term's "count" object variable. Default false. |
parent - Int
|
Parent term ID to retrieve direct-child terms of. Default empty. |
search - String
|
Search criteria to match terms. Will be SQL-formatted with wildcards before and after. Default empty. |
slug - [String]
|
Array of slugs to return term(s) for. Default empty. |
termTaxonomId - [ID]
|
Array of term taxonomy IDs, to match when querying terms. |
termTaxonomyId - [ID]
|
Array of term taxonomy IDs, to match when querying terms. |
updateTermMetaCache - Boolean
|
Whether to prime meta caches for matched terms. Default true. |
Example
{
"cacheDomain": "xyz789",
"childOf": 123,
"childless": false,
"descriptionLike": "abc123",
"exclude": ["4"],
"excludeTree": [4],
"hideEmpty": false,
"hierarchical": true,
"include": ["4"],
"name": ["abc123"],
"nameLike": "xyz789",
"objectIds": ["4"],
"order": "ASC",
"orderby": "COUNT",
"padCounts": false,
"parent": 123,
"search": "abc123",
"slug": ["xyz789"],
"termTaxonomId": ["4"],
"termTaxonomyId": ["4"],
"updateTermMetaCache": false
}
PostToTermNodeConnection
Description
Connection between the Post type and the TermNode type
Fields
| Field Name | Description |
|---|---|
edges - [PostToTermNodeConnectionEdge!]!
|
Edges for the PostToTermNodeConnection connection |
nodes - [TermNode!]!
|
The nodes of the connection, without the edges |
pageInfo - PostToTermNodeConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [PostToTermNodeConnectionEdge],
"nodes": [TermNode],
"pageInfo": PostToTermNodeConnectionPageInfo
}
PostToTermNodeConnectionEdge
PostToTermNodeConnectionPageInfo
Description
Page Info on the "PostToTermNodeConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "abc123",
"hasNextPage": true,
"hasPreviousPage": false,
"startCursor": "abc123"
}
PostToTermNodeConnectionWhereArgs
Description
Arguments for filtering the PostToTermNodeConnection connection
Fields
| Input Field | Description |
|---|---|
cacheDomain - String
|
Unique cache key to be produced when this query is stored in an object cache. Default is 'core'. |
childOf - Int
|
Term ID to retrieve child terms of. If multiple taxonomies are passed, $child_of is ignored. Default 0. |
childless - Boolean
|
True to limit results to terms that have no children. This parameter has no effect on non-hierarchical taxonomies. Default false. |
descriptionLike - String
|
Retrieve terms where the description is LIKE the input value. Default empty. |
exclude - [ID]
|
Array of term ids to exclude. If $include is non-empty, $exclude is ignored. Default empty array. |
excludeTree - [ID]
|
Array of term ids to exclude along with all of their descendant terms. If $include is non-empty, $exclude_tree is ignored. Default empty array. |
hideEmpty - Boolean
|
Whether to hide terms not assigned to any posts. Accepts true or false. Default false |
hierarchical - Boolean
|
Whether to include terms that have non-empty descendants (even if $hide_empty is set to true). Default true. |
include - [ID]
|
Array of term ids to include. Default empty array. |
name - [String]
|
Array of names to return term(s) for. Default empty. |
nameLike - String
|
Retrieve terms where the name is LIKE the input value. Default empty. |
objectIds - [ID]
|
Array of object IDs. Results will be limited to terms associated with these objects. |
order - OrderEnum
|
Direction the connection should be ordered in |
orderby - TermObjectsConnectionOrderbyEnum
|
Field(s) to order terms by. Defaults to 'name'. |
padCounts - Boolean
|
Whether to pad the quantity of a term's children in the quantity of each term's "count" object variable. Default false. |
parent - Int
|
Parent term ID to retrieve direct-child terms of. Default empty. |
search - String
|
Search criteria to match terms. Will be SQL-formatted with wildcards before and after. Default empty. |
slug - [String]
|
Array of slugs to return term(s) for. Default empty. |
taxonomies - [TaxonomyEnum]
|
The Taxonomy to filter terms by |
termTaxonomId - [ID]
|
Array of term taxonomy IDs, to match when querying terms. |
termTaxonomyId - [ID]
|
Array of term taxonomy IDs, to match when querying terms. |
updateTermMetaCache - Boolean
|
Whether to prime meta caches for matched terms. Default true. |
Example
{
"cacheDomain": "xyz789",
"childOf": 987,
"childless": false,
"descriptionLike": "xyz789",
"exclude": [4],
"excludeTree": [4],
"hideEmpty": true,
"hierarchical": true,
"include": ["4"],
"name": ["abc123"],
"nameLike": "xyz789",
"objectIds": ["4"],
"order": "ASC",
"orderby": "COUNT",
"padCounts": true,
"parent": 987,
"search": "xyz789",
"slug": ["xyz789"],
"taxonomies": ["CATEGORY"],
"termTaxonomId": ["4"],
"termTaxonomyId": ["4"],
"updateTermMetaCache": true
}
PostTypeLabelDetails
Description
Details for labels of the PostType
Fields
| Field Name | Description |
|---|---|
addNew - String
|
Default is ‘Add New’ for both hierarchical and non-hierarchical types. |
addNewItem - String
|
Label for adding a new singular item. |
allItems - String
|
Label to signify all items in a submenu link. |
archives - String
|
Label for archives in nav menus |
attributes - String
|
Label for the attributes meta box. |
editItem - String
|
Label for editing a singular item. |
featuredImage - String
|
Label for the Featured Image meta box title. |
filterItemsList - String
|
Label for the table views hidden heading. |
insertIntoItem - String
|
Label for the media frame button. |
itemsList - String
|
Label for the table hidden heading. |
itemsListNavigation - String
|
Label for the table pagination hidden heading. |
menuName - String
|
Label for the menu name. |
name - String
|
General name for the post type, usually plural. |
newItem - String
|
Label for the new item page title. |
notFound - String
|
Label used when no items are found. |
notFoundInTrash - String
|
Label used when no items are in the trash. |
parentItemColon - String
|
Label used to prefix parents of hierarchical items. |
removeFeaturedImage - String
|
Label for removing the featured image. |
searchItems - String
|
Label for searching plural items. |
setFeaturedImage - String
|
Label for setting the featured image. |
singularName - String
|
Name for one object of this post type. |
uploadedToThisItem - String
|
Label for the media frame filter. |
useFeaturedImage - String
|
Label in the media frame for using a featured image. |
viewItem - String
|
Label for viewing a singular item. |
viewItems - String
|
Label for viewing post type archives. |
Example
{
"addNew": "xyz789",
"addNewItem": "abc123",
"allItems": "abc123",
"archives": "xyz789",
"attributes": "xyz789",
"editItem": "abc123",
"featuredImage": "xyz789",
"filterItemsList": "abc123",
"insertIntoItem": "xyz789",
"itemsList": "xyz789",
"itemsListNavigation": "abc123",
"menuName": "abc123",
"name": "xyz789",
"newItem": "xyz789",
"notFound": "xyz789",
"notFoundInTrash": "abc123",
"parentItemColon": "xyz789",
"removeFeaturedImage": "abc123",
"searchItems": "xyz789",
"setFeaturedImage": "xyz789",
"singularName": "abc123",
"uploadedToThisItem": "xyz789",
"useFeaturedImage": "xyz789",
"viewItem": "xyz789",
"viewItems": "abc123"
}
Previewable
Description
Nodes that can be seen in a preview (unpublished) state.
Fields
| Field Name | Description |
|---|---|
isPreview - Boolean
|
Whether the object is a node in the preview state |
previewRevisionDatabaseId - Int
|
The database id of the preview node |
previewRevisionId - ID
|
Whether the object is a node in the preview state |
Possible Types
| Previewable Types |
|---|
Example
{"isPreview": true, "previewRevisionDatabaseId": 987, "previewRevisionId": 4}
ReadingSettings
Description
The reading setting type
Example
{
"pageForPosts": 987,
"pageOnFront": 987,
"postsPerPage": 987,
"showOnFront": "abc123"
}
RegisterUserInput
Description
Input for the registerUser mutation.
Fields
| Input Field | Description |
|---|---|
aim - String
|
User's AOL IM account. |
clientMutationId - String
|
This is an ID that can be passed to a mutation by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
description - String
|
A string containing content about the user. |
displayName - String
|
A string that will be shown on the site. Defaults to user's username. It is likely that you will want to change this, for both appearance and security through obscurity (that is if you dont use and delete the default admin user). |
email - String
|
A string containing the user's email address. |
firstName - String
|
|
jabber - String
|
User's Jabber account. |
lastName - String
|
The user's last name. |
locale - String
|
User's locale. |
nicename - String
|
A string that contains a URL-friendly name for the user. The default is the user's username. |
nickname - String
|
The user's nickname, defaults to the user's username. |
password - String
|
A string that contains the plain text password for the user. |
registered - String
|
The date the user registered. Format is Y-m-d H:i:s. |
richEditing - String
|
A string for whether to enable the rich editor or not. False if not empty. |
username - String!
|
A string that contains the user's username. |
websiteUrl - String
|
A string containing the user's URL for the user's web site. |
yim - String
|
User's Yahoo IM account. |
Example
{
"aim": "xyz789",
"clientMutationId": "abc123",
"description": "abc123",
"displayName": "xyz789",
"email": "xyz789",
"firstName": "xyz789",
"jabber": "abc123",
"lastName": "xyz789",
"locale": "abc123",
"nicename": "xyz789",
"nickname": "xyz789",
"password": "xyz789",
"registered": "xyz789",
"richEditing": "abc123",
"username": "xyz789",
"websiteUrl": "abc123",
"yim": "xyz789"
}
RegisterUserPayload
Description
The payload for the registerUser mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
If a 'clientMutationId' input is provided to the mutation, it will be returned as output on the mutation. This ID can be used by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
user - User
|
The User object mutation type. |
Example
{
"clientMutationId": "xyz789",
"user": User
}
RelationEnum
Description
The logical relation between each item in the array when there are more than one.
Values
| Enum Value | Description |
|---|---|
|
|
The logical AND condition returns true if both operands are true, otherwise, it returns false. |
|
|
The logical OR condition returns false if both operands are false, otherwise, it returns true. |
Example
"AND"
Release
Description
The release type
Fields
| Field Name | Description |
|---|---|
content - String
|
The content of the post. |
Arguments
|
|
contentType - ContentNodeToContentTypeConnectionEdge
|
Connection between the ContentNode type and the ContentType type |
contentTypeName - String!
|
The name of the Content Type the node belongs to |
databaseId - Int!
|
The unique identifier stored in the database |
date - String
|
Post publishing date. |
dateGmt - String
|
The publishing date set in GMT. |
desiredSlug - String
|
The desired slug of the post |
editingLockedBy - ContentNodeToEditLockConnectionEdge
|
If a user has edited the node within the past 15 seconds, this will return the user that last edited. Null if the edit lock doesn't exist or is greater than 15 seconds |
enclosure - String
|
The RSS enclosure for the object |
enqueuedScripts - ContentNodeToEnqueuedScriptConnection
|
Connection between the ContentNode type and the EnqueuedScript type |
Arguments
|
|
enqueuedStylesheets - ContentNodeToEnqueuedStylesheetConnection
|
Connection between the ContentNode type and the EnqueuedStylesheet type |
Arguments
|
|
expirationTime - String
|
Vanhentumisaika |
guid - String
|
The global unique identifier for this post. This currently matches the value stored in WP_Post->guid and the guid column in the "post_objects" database table. |
id - ID!
|
The globally unique identifier of the release-cpt object. |
isComment - Boolean!
|
Whether the node is a Comment |
isContentNode - Boolean!
|
Whether the node is a Content Node |
isFrontPage - Boolean!
|
Whether the node represents the front page. |
isPostsPage - Boolean!
|
Whether the node represents the blog page. |
isPreview - Boolean
|
Whether the object is a node in the preview state |
isRestricted - Boolean
|
Whether the object is restricted from the current viewer |
isRevision - Boolean
|
True if the node is a revision of another node |
isTermNode - Boolean!
|
Whether the node is a Term |
language - Language
|
Polylang language |
lastEditedBy - ContentNodeToEditLastConnectionEdge
|
The user that most recently edited the node |
link - String
|
The permalink of the post |
modified - String
|
The local modified time for a post. If a post was recently updated the modified field will change to match the corresponding time. |
modifiedGmt - String
|
The GMT modified time for a post. If a post was recently updated the modified field will change to match the corresponding time in GMT. |
preview - ReleaseToPreviewConnectionEdge
|
Connection between the Release type and the release type |
previewRevisionDatabaseId - Int
|
The database id of the preview node |
previewRevisionId - ID
|
Whether the object is a node in the preview state |
releaseId - Int!
|
The id field matches the WP_Post->ID field. Deprecated in favor of the databaseId field |
revisionOf - NodeWithRevisionsToContentNodeConnectionEdge
|
If the current node is a revision, this field exposes the node this is a revision of. Returns null if the node is not a revision of another node. |
revisions - ReleaseToRevisionConnection
|
Connection between the Release type and the release type |
Arguments
|
|
seo - SEO
|
The SEO Framework data of the release |
slug - String
|
The uri slug for the post. This is equivalent to the WP_Post->post_name field and the post_name column in the database for the "post_objects" table. |
status - String
|
The current status of the object |
template - ContentTemplate
|
The template assigned to the node |
title - String
|
The title of the post. This is currently just the raw title. An amendment to support rendered title needs to be made. |
Arguments
|
|
translation - Release
|
Get specific translation version of this object |
Arguments
|
|
translations - [Release]
|
List all translated versions of this post |
uri - String
|
The unique resource identifier path |
Example
{
"content": "abc123",
"contentType": ContentNodeToContentTypeConnectionEdge,
"contentTypeName": "abc123",
"databaseId": 123,
"date": "xyz789",
"dateGmt": "abc123",
"desiredSlug": "abc123",
"editingLockedBy": ContentNodeToEditLockConnectionEdge,
"enclosure": "abc123",
"enqueuedScripts": ContentNodeToEnqueuedScriptConnection,
"enqueuedStylesheets": ContentNodeToEnqueuedStylesheetConnection,
"expirationTime": "abc123",
"guid": "abc123",
"id": 4,
"isComment": false,
"isContentNode": true,
"isFrontPage": false,
"isPostsPage": true,
"isPreview": true,
"isRestricted": true,
"isRevision": false,
"isTermNode": true,
"language": Language,
"lastEditedBy": ContentNodeToEditLastConnectionEdge,
"link": "xyz789",
"modified": "abc123",
"modifiedGmt": "abc123",
"preview": ReleaseToPreviewConnectionEdge,
"previewRevisionDatabaseId": 987,
"previewRevisionId": 4,
"releaseId": 123,
"revisionOf": NodeWithRevisionsToContentNodeConnectionEdge,
"revisions": ReleaseToRevisionConnection,
"seo": SEO,
"slug": "xyz789",
"status": "abc123",
"template": ContentTemplate,
"title": "abc123",
"translation": Release,
"translations": [Release],
"uri": "abc123"
}
ReleaseConnection
Description
Connection to release Nodes
Fields
| Field Name | Description |
|---|---|
edges - [ReleaseConnectionEdge!]!
|
A list of edges (relational context) between RootQuery and connected release Nodes |
nodes - [Release!]!
|
A list of connected release Nodes |
pageInfo - ReleaseConnectionPageInfo!
|
Information about pagination in a connection. |
Possible Types
| ReleaseConnection Types |
|---|
Example
{
"edges": [ReleaseConnectionEdge],
"nodes": [Release],
"pageInfo": ReleaseConnectionPageInfo
}
ReleaseConnectionEdge
Description
Edge between a Node and a connected release
Fields
| Field Name | Description |
|---|---|
cursor - String
|
Opaque reference to the nodes position in the connection. Value can be used with pagination args. |
node - Release!
|
The connected release Node |
Possible Types
| ReleaseConnectionEdge Types |
|---|
Example
{
"cursor": "abc123",
"node": Release
}
ReleaseConnectionPageInfo
Description
Page Info on the connected ReleaseConnectionEdge
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Possible Types
| ReleaseConnectionPageInfo Types |
|---|
Example
{
"endCursor": "abc123",
"hasNextPage": false,
"hasPreviousPage": false,
"startCursor": "xyz789"
}
ReleaseIdType
Description
The Type of Identifier used to fetch a single resource. Default is ID.
Values
| Enum Value | Description |
|---|---|
|
|
Identify a resource by the Database ID. |
|
|
Identify a resource by the (hashed) Global ID. |
|
|
Identify a resource by the slug. Available to non-hierarchcial Types where the slug is a unique identifier. |
|
|
Identify a resource by the URI. |
Example
"DATABASE_ID"
ReleaseToPreviewConnectionEdge
Description
Connection between the Release type and the release type
Example
{
"cursor": "xyz789",
"node": Release
}
ReleaseToRevisionConnection
Description
Connection between the Release type and the release type
Fields
| Field Name | Description |
|---|---|
edges - [ReleaseToRevisionConnectionEdge!]!
|
Edges for the ReleaseToRevisionConnection connection |
nodes - [Release!]!
|
The nodes of the connection, without the edges |
pageInfo - ReleaseToRevisionConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [ReleaseToRevisionConnectionEdge],
"nodes": [Release],
"pageInfo": ReleaseToRevisionConnectionPageInfo
}
ReleaseToRevisionConnectionEdge
ReleaseToRevisionConnectionPageInfo
Description
Page Info on the "ReleaseToRevisionConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "abc123",
"hasNextPage": false,
"hasPreviousPage": false,
"startCursor": "xyz789"
}
ReleaseToRevisionConnectionWhereArgs
Description
Arguments for filtering the ReleaseToRevisionConnection connection
Fields
| Input Field | Description |
|---|---|
dateQuery - DateQueryInput
|
Filter the connection based on dates |
hasPassword - Boolean
|
True for objects with passwords; False for objects without passwords; null for all objects with or without passwords |
id - Int
|
Specific database ID of the object |
in - [ID]
|
Array of IDs for the objects to retrieve |
mimeType - MimeTypeEnum
|
Get objects with a specific mimeType property |
name - String
|
Slug / post_name of the object |
nameIn - [String]
|
Specify objects to retrieve. Use slugs |
notIn - [ID]
|
Specify IDs NOT to retrieve. If this is used in the same query as "in", it will be ignored |
orderby - [PostObjectsConnectionOrderbyInput]
|
What parameter to use to order the objects by. |
parent - ID
|
Use ID to return only children. Use 0 to return only top-level items |
parentIn - [ID]
|
Specify objects whose parent is in an array |
parentNotIn - [ID]
|
Specify posts whose parent is not in an array |
password - String
|
Show posts with a specific password. |
search - String
|
Show Posts based on a keyword search |
stati - [PostStatusEnum]
|
Retrieve posts where post status is in an array. |
status - PostStatusEnum
|
Show posts with a specific status. |
title - String
|
Title of the object |
Example
{
"dateQuery": DateQueryInput,
"hasPassword": true,
"id": 987,
"in": ["4"],
"mimeType": "APPLICATION_MSWORD",
"name": "abc123",
"nameIn": ["xyz789"],
"notIn": ["4"],
"orderby": [PostObjectsConnectionOrderbyInput],
"parent": 4,
"parentIn": ["4"],
"parentNotIn": ["4"],
"password": "abc123",
"search": "abc123",
"stati": ["ACF_DISABLED"],
"status": "ACF_DISABLED",
"title": "xyz789"
}
ResetUserPasswordInput
Description
Input for the resetUserPassword mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
This is an ID that can be passed to a mutation by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
key - String
|
Password reset key |
login - String
|
The user's login (username). |
password - String
|
The new password. |
Example
{
"clientMutationId": "xyz789",
"key": "abc123",
"login": "abc123",
"password": "xyz789"
}
ResetUserPasswordPayload
Description
The payload for the resetUserPassword mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
If a 'clientMutationId' input is provided to the mutation, it will be returned as output on the mutation. This ID can be used by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
user - User
|
The User object mutation type. |
Example
{
"clientMutationId": "xyz789",
"user": User
}
RestoreCommentInput
Description
Input for the restoreComment mutation.
Example
{
"clientMutationId": "abc123",
"id": "4"
}
RestoreCommentPayload
Description
The payload for the restoreComment mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
If a 'clientMutationId' input is provided to the mutation, it will be returned as output on the mutation. This ID can be used by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
comment - Comment
|
The restored comment object |
restoredId - ID
|
The ID of the restored comment |
Example
{
"clientMutationId": "xyz789",
"comment": Comment,
"restoredId": "4"
}
RootQueryToCategoryConnection
Description
Connection between the RootQuery type and the category type
Fields
| Field Name | Description |
|---|---|
edges - [RootQueryToCategoryConnectionEdge!]!
|
Edges for the RootQueryToCategoryConnection connection |
nodes - [Category!]!
|
The nodes of the connection, without the edges |
pageInfo - RootQueryToCategoryConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [RootQueryToCategoryConnectionEdge],
"nodes": [Category],
"pageInfo": RootQueryToCategoryConnectionPageInfo
}
RootQueryToCategoryConnectionEdge
RootQueryToCategoryConnectionPageInfo
Description
Page Info on the "RootQueryToCategoryConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "xyz789",
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "abc123"
}
RootQueryToCategoryConnectionWhereArgs
Description
Arguments for filtering the RootQueryToCategoryConnection connection
Fields
| Input Field | Description |
|---|---|
cacheDomain - String
|
Unique cache key to be produced when this query is stored in an object cache. Default is 'core'. |
childOf - Int
|
Term ID to retrieve child terms of. If multiple taxonomies are passed, $child_of is ignored. Default 0. |
childless - Boolean
|
True to limit results to terms that have no children. This parameter has no effect on non-hierarchical taxonomies. Default false. |
descriptionLike - String
|
Retrieve terms where the description is LIKE the input value. Default empty. |
exclude - [ID]
|
Array of term ids to exclude. If $include is non-empty, $exclude is ignored. Default empty array. |
excludeTree - [ID]
|
Array of term ids to exclude along with all of their descendant terms. If $include is non-empty, $exclude_tree is ignored. Default empty array. |
hideEmpty - Boolean
|
Whether to hide terms not assigned to any posts. Accepts true or false. Default false |
hierarchical - Boolean
|
Whether to include terms that have non-empty descendants (even if $hide_empty is set to true). Default true. |
include - [ID]
|
Array of term ids to include. Default empty array. |
language - LanguageCodeFilterEnum
|
Filter by Categorys by language code (Polylang) |
languages - [LanguageCodeEnum!]
|
Filter Categorys by one or more languages (Polylang) |
name - [String]
|
Array of names to return term(s) for. Default empty. |
nameLike - String
|
Retrieve terms where the name is LIKE the input value. Default empty. |
objectIds - [ID]
|
Array of object IDs. Results will be limited to terms associated with these objects. |
order - OrderEnum
|
Direction the connection should be ordered in |
orderby - TermObjectsConnectionOrderbyEnum
|
Field(s) to order terms by. Defaults to 'name'. |
padCounts - Boolean
|
Whether to pad the quantity of a term's children in the quantity of each term's "count" object variable. Default false. |
parent - Int
|
Parent term ID to retrieve direct-child terms of. Default empty. |
search - String
|
Search criteria to match terms. Will be SQL-formatted with wildcards before and after. Default empty. |
slug - [String]
|
Array of slugs to return term(s) for. Default empty. |
termTaxonomId - [ID]
|
Array of term taxonomy IDs, to match when querying terms. |
termTaxonomyId - [ID]
|
Array of term taxonomy IDs, to match when querying terms. |
updateTermMetaCache - Boolean
|
Whether to prime meta caches for matched terms. Default true. |
Example
{
"cacheDomain": "xyz789",
"childOf": 987,
"childless": false,
"descriptionLike": "xyz789",
"exclude": ["4"],
"excludeTree": ["4"],
"hideEmpty": true,
"hierarchical": false,
"include": ["4"],
"language": "ALL",
"languages": ["EN"],
"name": ["abc123"],
"nameLike": "abc123",
"objectIds": [4],
"order": "ASC",
"orderby": "COUNT",
"padCounts": true,
"parent": 987,
"search": "xyz789",
"slug": ["xyz789"],
"termTaxonomId": [4],
"termTaxonomyId": [4],
"updateTermMetaCache": false
}
RootQueryToCollectionConnection
Description
Connection between the RootQuery type and the collection type
Fields
| Field Name | Description |
|---|---|
edges - [RootQueryToCollectionConnectionEdge!]!
|
Edges for the RootQueryToCollectionConnection connection |
nodes - [Collection!]!
|
The nodes of the connection, without the edges |
pageInfo - RootQueryToCollectionConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [RootQueryToCollectionConnectionEdge],
"nodes": [Collection],
"pageInfo": RootQueryToCollectionConnectionPageInfo
}
RootQueryToCollectionConnectionEdge
Description
An edge in a connection
Fields
| Field Name | Description |
|---|---|
cursor - String
|
A cursor for use in pagination |
node - Collection!
|
The item at the end of the edge |
Example
{
"cursor": "xyz789",
"node": Collection
}
RootQueryToCollectionConnectionPageInfo
Description
Page Info on the "RootQueryToCollectionConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "xyz789",
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "xyz789"
}
RootQueryToCollectionConnectionWhereArgs
Description
Arguments for filtering the RootQueryToCollectionConnection connection
Fields
| Input Field | Description |
|---|---|
dateQuery - DateQueryInput
|
Filter the connection based on dates |
hasPassword - Boolean
|
True for objects with passwords; False for objects without passwords; null for all objects with or without passwords |
id - Int
|
Specific database ID of the object |
in - [ID]
|
Array of IDs for the objects to retrieve |
language - LanguageCodeFilterEnum
|
Filter by Collections by language code (Polylang) |
languages - [LanguageCodeEnum!]
|
Filter Collections by one or more languages (Polylang) |
mimeType - MimeTypeEnum
|
Get objects with a specific mimeType property |
name - String
|
Slug / post_name of the object |
nameIn - [String]
|
Specify objects to retrieve. Use slugs |
notIn - [ID]
|
Specify IDs NOT to retrieve. If this is used in the same query as "in", it will be ignored |
orderby - [PostObjectsConnectionOrderbyInput]
|
What parameter to use to order the objects by. |
parent - ID
|
Use ID to return only children. Use 0 to return only top-level items |
parentIn - [ID]
|
Specify objects whose parent is in an array |
parentNotIn - [ID]
|
Specify posts whose parent is not in an array |
password - String
|
Show posts with a specific password. |
search - String
|
Show Posts based on a keyword search |
stati - [PostStatusEnum]
|
Retrieve posts where post status is in an array. |
status - PostStatusEnum
|
Show posts with a specific status. |
title - String
|
Title of the object |
Example
{
"dateQuery": DateQueryInput,
"hasPassword": false,
"id": 123,
"in": ["4"],
"language": "ALL",
"languages": ["EN"],
"mimeType": "APPLICATION_MSWORD",
"name": "xyz789",
"nameIn": ["abc123"],
"notIn": [4],
"orderby": [PostObjectsConnectionOrderbyInput],
"parent": 4,
"parentIn": ["4"],
"parentNotIn": ["4"],
"password": "xyz789",
"search": "xyz789",
"stati": ["ACF_DISABLED"],
"status": "ACF_DISABLED",
"title": "abc123"
}
RootQueryToCommentConnection
Description
Connection between the RootQuery type and the Comment type
Fields
| Field Name | Description |
|---|---|
edges - [RootQueryToCommentConnectionEdge!]!
|
Edges for the RootQueryToCommentConnection connection |
nodes - [Comment!]!
|
The nodes of the connection, without the edges |
pageInfo - RootQueryToCommentConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [RootQueryToCommentConnectionEdge],
"nodes": [Comment],
"pageInfo": RootQueryToCommentConnectionPageInfo
}
RootQueryToCommentConnectionEdge
RootQueryToCommentConnectionPageInfo
Description
Page Info on the "RootQueryToCommentConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "xyz789",
"hasNextPage": false,
"hasPreviousPage": false,
"startCursor": "xyz789"
}
RootQueryToCommentConnectionWhereArgs
Description
Arguments for filtering the RootQueryToCommentConnection connection
Fields
| Input Field | Description |
|---|---|
authorEmail - String
|
Comment author email address. |
authorIn - [ID]
|
Array of author IDs to include comments for. |
authorNotIn - [ID]
|
Array of author IDs to exclude comments for. |
authorUrl - String
|
Comment author URL. |
commentIn - [ID]
|
Array of comment IDs to include. |
commentNotIn - [ID]
|
Array of IDs of users whose unapproved comments will be returned by the query regardless of status. |
commentType - String
|
Include comments of a given type. |
commentTypeIn - [String]
|
Include comments from a given array of comment types. |
commentTypeNotIn - String
|
Exclude comments from a given array of comment types. |
contentAuthor - [ID]
|
Content object author ID to limit results by. |
contentAuthorIn - [ID]
|
Array of author IDs to retrieve comments for. |
contentAuthorNotIn - [ID]
|
Array of author IDs not to retrieve comments for. |
contentId - ID
|
Limit results to those affiliated with a given content object ID. |
contentIdIn - [ID]
|
Array of content object IDs to include affiliated comments for. |
contentIdNotIn - [ID]
|
Array of content object IDs to exclude affiliated comments for. |
contentName - String
|
Content object name (i.e. slug ) to retrieve affiliated comments for. |
contentParent - Int
|
Content Object parent ID to retrieve affiliated comments for. |
contentStatus - [PostStatusEnum]
|
Array of content object statuses to retrieve affiliated comments for. Pass 'any' to match any value. |
contentType - [ContentTypeEnum]
|
Content object type or array of types to retrieve affiliated comments for. Pass 'any' to match any value. |
includeUnapproved - [ID]
|
Array of IDs or email addresses of users whose unapproved comments will be returned by the query regardless of $status. Default empty |
karma - Int
|
Karma score to retrieve matching comments for. |
order - OrderEnum
|
The cardinality of the order of the connection |
orderby - CommentsConnectionOrderbyEnum
|
Field to order the comments by. |
parent - Int
|
Parent ID of comment to retrieve children of. |
parentIn - [ID]
|
Array of parent IDs of comments to retrieve children for. |
parentNotIn - [ID]
|
Array of parent IDs of comments not to retrieve children for. |
search - String
|
Search term(s) to retrieve matching comments for. |
status - String
|
Comment status to limit results by. |
userId - ID
|
Include comments for a specific user ID. |
Example
{
"authorEmail": "abc123",
"authorIn": ["4"],
"authorNotIn": [4],
"authorUrl": "xyz789",
"commentIn": ["4"],
"commentNotIn": [4],
"commentType": "abc123",
"commentTypeIn": ["abc123"],
"commentTypeNotIn": "xyz789",
"contentAuthor": [4],
"contentAuthorIn": ["4"],
"contentAuthorNotIn": [4],
"contentId": "4",
"contentIdIn": ["4"],
"contentIdNotIn": ["4"],
"contentName": "xyz789",
"contentParent": 123,
"contentStatus": ["ACF_DISABLED"],
"contentType": ["ATTACHMENT"],
"includeUnapproved": [4],
"karma": 123,
"order": "ASC",
"orderby": "COMMENT_AGENT",
"parent": 987,
"parentIn": [4],
"parentNotIn": [4],
"search": "xyz789",
"status": "abc123",
"userId": "4"
}
RootQueryToContactConnection
Description
Connection between the RootQuery type and the contact type
Fields
| Field Name | Description |
|---|---|
edges - [RootQueryToContactConnectionEdge!]!
|
Edges for the RootQueryToContactConnection connection |
nodes - [Contact!]!
|
The nodes of the connection, without the edges |
pageInfo - RootQueryToContactConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [RootQueryToContactConnectionEdge],
"nodes": [Contact],
"pageInfo": RootQueryToContactConnectionPageInfo
}
RootQueryToContactConnectionEdge
RootQueryToContactConnectionPageInfo
Description
Page Info on the "RootQueryToContactConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "xyz789",
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "xyz789"
}
RootQueryToContactConnectionWhereArgs
Description
Arguments for filtering the RootQueryToContactConnection connection
Fields
| Input Field | Description |
|---|---|
dateQuery - DateQueryInput
|
Filter the connection based on dates |
hasPassword - Boolean
|
True for objects with passwords; False for objects without passwords; null for all objects with or without passwords |
id - Int
|
Specific database ID of the object |
in - [ID]
|
Array of IDs for the objects to retrieve |
language - LanguageCodeFilterEnum
|
Filter by Contacts by language code (Polylang) |
languages - [LanguageCodeEnum!]
|
Filter Contacts by one or more languages (Polylang) |
mimeType - MimeTypeEnum
|
Get objects with a specific mimeType property |
name - String
|
Slug / post_name of the object |
nameIn - [String]
|
Specify objects to retrieve. Use slugs |
notIn - [ID]
|
Specify IDs NOT to retrieve. If this is used in the same query as "in", it will be ignored |
orderby - [PostObjectsConnectionOrderbyInput]
|
What parameter to use to order the objects by. |
parent - ID
|
Use ID to return only children. Use 0 to return only top-level items |
parentIn - [ID]
|
Specify objects whose parent is in an array |
parentNotIn - [ID]
|
Specify posts whose parent is not in an array |
password - String
|
Show posts with a specific password. |
search - String
|
Show Posts based on a keyword search |
stati - [PostStatusEnum]
|
Retrieve posts where post status is in an array. |
status - PostStatusEnum
|
Show posts with a specific status. |
title - String
|
Title of the object |
Example
{
"dateQuery": DateQueryInput,
"hasPassword": false,
"id": 123,
"in": [4],
"language": "ALL",
"languages": ["EN"],
"mimeType": "APPLICATION_MSWORD",
"name": "xyz789",
"nameIn": ["abc123"],
"notIn": [4],
"orderby": [PostObjectsConnectionOrderbyInput],
"parent": 4,
"parentIn": ["4"],
"parentNotIn": [4],
"password": "abc123",
"search": "abc123",
"stati": ["ACF_DISABLED"],
"status": "ACF_DISABLED",
"title": "xyz789"
}
RootQueryToContentNodeConnection
Description
Connection between the RootQuery type and the ContentNode type
Fields
| Field Name | Description |
|---|---|
edges - [RootQueryToContentNodeConnectionEdge!]!
|
Edges for the RootQueryToContentNodeConnection connection |
nodes - [ContentNode!]!
|
The nodes of the connection, without the edges |
pageInfo - RootQueryToContentNodeConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [RootQueryToContentNodeConnectionEdge],
"nodes": [ContentNode],
"pageInfo": RootQueryToContentNodeConnectionPageInfo
}
RootQueryToContentNodeConnectionEdge
Description
An edge in a connection
Fields
| Field Name | Description |
|---|---|
cursor - String
|
A cursor for use in pagination |
node - ContentNode!
|
The item at the end of the edge |
Example
{
"cursor": "abc123",
"node": ContentNode
}
RootQueryToContentNodeConnectionPageInfo
Description
Page Info on the "RootQueryToContentNodeConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "abc123",
"hasNextPage": true,
"hasPreviousPage": false,
"startCursor": "abc123"
}
RootQueryToContentNodeConnectionWhereArgs
Description
Arguments for filtering the RootQueryToContentNodeConnection connection
Fields
| Input Field | Description |
|---|---|
contentTypes - [ContentTypeEnum]
|
The Types of content to filter |
dateQuery - DateQueryInput
|
Filter the connection based on dates |
hasPassword - Boolean
|
True for objects with passwords; False for objects without passwords; null for all objects with or without passwords |
id - Int
|
Specific database ID of the object |
in - [ID]
|
Array of IDs for the objects to retrieve |
language - LanguageCodeFilterEnum
|
Filter content nodes by language code (Polylang) |
languages - [LanguageCodeEnum!]
|
Filter content nodes by one or more languages (Polylang) |
mimeType - MimeTypeEnum
|
Get objects with a specific mimeType property |
name - String
|
Slug / post_name of the object |
nameIn - [String]
|
Specify objects to retrieve. Use slugs |
notIn - [ID]
|
Specify IDs NOT to retrieve. If this is used in the same query as "in", it will be ignored |
orderby - [PostObjectsConnectionOrderbyInput]
|
What parameter to use to order the objects by. |
parent - ID
|
Use ID to return only children. Use 0 to return only top-level items |
parentIn - [ID]
|
Specify objects whose parent is in an array |
parentNotIn - [ID]
|
Specify posts whose parent is not in an array |
password - String
|
Show posts with a specific password. |
search - String
|
Show Posts based on a keyword search |
stati - [PostStatusEnum]
|
Retrieve posts where post status is in an array. |
status - PostStatusEnum
|
Show posts with a specific status. |
title - String
|
Title of the object |
Example
{
"contentTypes": ["ATTACHMENT"],
"dateQuery": DateQueryInput,
"hasPassword": true,
"id": 987,
"in": [4],
"language": "ALL",
"languages": ["EN"],
"mimeType": "APPLICATION_MSWORD",
"name": "xyz789",
"nameIn": ["xyz789"],
"notIn": [4],
"orderby": [PostObjectsConnectionOrderbyInput],
"parent": "4",
"parentIn": ["4"],
"parentNotIn": [4],
"password": "xyz789",
"search": "xyz789",
"stati": ["ACF_DISABLED"],
"status": "ACF_DISABLED",
"title": "abc123"
}
RootQueryToContentTypeConnection
Description
Connection between the RootQuery type and the ContentType type
Fields
| Field Name | Description |
|---|---|
edges - [RootQueryToContentTypeConnectionEdge!]!
|
Edges for the RootQueryToContentTypeConnection connection |
nodes - [ContentType!]!
|
The nodes of the connection, without the edges |
pageInfo - RootQueryToContentTypeConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [RootQueryToContentTypeConnectionEdge],
"nodes": [ContentType],
"pageInfo": RootQueryToContentTypeConnectionPageInfo
}
RootQueryToContentTypeConnectionEdge
Description
An edge in a connection
Fields
| Field Name | Description |
|---|---|
cursor - String
|
A cursor for use in pagination |
node - ContentType!
|
The item at the end of the edge |
Example
{
"cursor": "xyz789",
"node": ContentType
}
RootQueryToContentTypeConnectionPageInfo
Description
Page Info on the "RootQueryToContentTypeConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "xyz789",
"hasNextPage": false,
"hasPreviousPage": false,
"startCursor": "xyz789"
}
RootQueryToEnqueuedScriptConnection
Description
Connection between the RootQuery type and the EnqueuedScript type
Fields
| Field Name | Description |
|---|---|
edges - [RootQueryToEnqueuedScriptConnectionEdge!]!
|
Edges for the RootQueryToEnqueuedScriptConnection connection |
nodes - [EnqueuedScript!]!
|
The nodes of the connection, without the edges |
pageInfo - RootQueryToEnqueuedScriptConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [RootQueryToEnqueuedScriptConnectionEdge],
"nodes": [EnqueuedScript],
"pageInfo": RootQueryToEnqueuedScriptConnectionPageInfo
}
RootQueryToEnqueuedScriptConnectionEdge
Description
An edge in a connection
Fields
| Field Name | Description |
|---|---|
cursor - String
|
A cursor for use in pagination |
node - EnqueuedScript!
|
The item at the end of the edge |
Example
{
"cursor": "xyz789",
"node": EnqueuedScript
}
RootQueryToEnqueuedScriptConnectionPageInfo
Description
Page Info on the "RootQueryToEnqueuedScriptConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "xyz789",
"hasNextPage": false,
"hasPreviousPage": false,
"startCursor": "abc123"
}
RootQueryToEnqueuedStylesheetConnection
Description
Connection between the RootQuery type and the EnqueuedStylesheet type
Fields
| Field Name | Description |
|---|---|
edges - [RootQueryToEnqueuedStylesheetConnectionEdge!]!
|
Edges for the RootQueryToEnqueuedStylesheetConnection connection |
nodes - [EnqueuedStylesheet!]!
|
The nodes of the connection, without the edges |
pageInfo - RootQueryToEnqueuedStylesheetConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [RootQueryToEnqueuedStylesheetConnectionEdge],
"nodes": [EnqueuedStylesheet],
"pageInfo": RootQueryToEnqueuedStylesheetConnectionPageInfo
}
RootQueryToEnqueuedStylesheetConnectionEdge
Description
An edge in a connection
Fields
| Field Name | Description |
|---|---|
cursor - String
|
A cursor for use in pagination |
node - EnqueuedStylesheet!
|
The item at the end of the edge |
Example
{
"cursor": "xyz789",
"node": EnqueuedStylesheet
}
RootQueryToEnqueuedStylesheetConnectionPageInfo
Description
Page Info on the "RootQueryToEnqueuedStylesheetConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "xyz789",
"hasNextPage": false,
"hasPreviousPage": true,
"startCursor": "xyz789"
}
RootQueryToLandingPageConnection
Description
Connection between the RootQuery type and the landingPage type
Fields
| Field Name | Description |
|---|---|
edges - [RootQueryToLandingPageConnectionEdge!]!
|
Edges for the RootQueryToLandingPageConnection connection |
nodes - [LandingPage!]!
|
The nodes of the connection, without the edges |
pageInfo - RootQueryToLandingPageConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [RootQueryToLandingPageConnectionEdge],
"nodes": [LandingPage],
"pageInfo": RootQueryToLandingPageConnectionPageInfo
}
RootQueryToLandingPageConnectionEdge
Description
An edge in a connection
Fields
| Field Name | Description |
|---|---|
cursor - String
|
A cursor for use in pagination |
node - LandingPage!
|
The item at the end of the edge |
Example
{
"cursor": "xyz789",
"node": LandingPage
}
RootQueryToLandingPageConnectionPageInfo
Description
Page Info on the "RootQueryToLandingPageConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "abc123",
"hasNextPage": true,
"hasPreviousPage": false,
"startCursor": "xyz789"
}
RootQueryToLandingPageConnectionWhereArgs
Description
Arguments for filtering the RootQueryToLandingPageConnection connection
Fields
| Input Field | Description |
|---|---|
dateQuery - DateQueryInput
|
Filter the connection based on dates |
hasPassword - Boolean
|
True for objects with passwords; False for objects without passwords; null for all objects with or without passwords |
id - Int
|
Specific database ID of the object |
in - [ID]
|
Array of IDs for the objects to retrieve |
language - LanguageCodeFilterEnum
|
Filter by LandingPages by language code (Polylang) |
languages - [LanguageCodeEnum!]
|
Filter LandingPages by one or more languages (Polylang) |
mimeType - MimeTypeEnum
|
Get objects with a specific mimeType property |
name - String
|
Slug / post_name of the object |
nameIn - [String]
|
Specify objects to retrieve. Use slugs |
notIn - [ID]
|
Specify IDs NOT to retrieve. If this is used in the same query as "in", it will be ignored |
orderby - [PostObjectsConnectionOrderbyInput]
|
What parameter to use to order the objects by. |
parent - ID
|
Use ID to return only children. Use 0 to return only top-level items |
parentIn - [ID]
|
Specify objects whose parent is in an array |
parentNotIn - [ID]
|
Specify posts whose parent is not in an array |
password - String
|
Show posts with a specific password. |
search - String
|
Show Posts based on a keyword search |
stati - [PostStatusEnum]
|
Retrieve posts where post status is in an array. |
status - PostStatusEnum
|
Show posts with a specific status. |
title - String
|
Title of the object |
Example
{
"dateQuery": DateQueryInput,
"hasPassword": true,
"id": 987,
"in": [4],
"language": "ALL",
"languages": ["EN"],
"mimeType": "APPLICATION_MSWORD",
"name": "abc123",
"nameIn": ["xyz789"],
"notIn": ["4"],
"orderby": [PostObjectsConnectionOrderbyInput],
"parent": 4,
"parentIn": [4],
"parentNotIn": ["4"],
"password": "abc123",
"search": "abc123",
"stati": ["ACF_DISABLED"],
"status": "ACF_DISABLED",
"title": "abc123"
}
RootQueryToMediaItemConnection
Description
Connection between the RootQuery type and the mediaItem type
Fields
| Field Name | Description |
|---|---|
edges - [RootQueryToMediaItemConnectionEdge!]!
|
Edges for the RootQueryToMediaItemConnection connection |
nodes - [MediaItem!]!
|
The nodes of the connection, without the edges |
pageInfo - RootQueryToMediaItemConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [RootQueryToMediaItemConnectionEdge],
"nodes": [MediaItem],
"pageInfo": RootQueryToMediaItemConnectionPageInfo
}
RootQueryToMediaItemConnectionEdge
Description
An edge in a connection
Fields
| Field Name | Description |
|---|---|
cursor - String
|
A cursor for use in pagination |
node - MediaItem!
|
The item at the end of the edge |
Example
{
"cursor": "xyz789",
"node": MediaItem
}
RootQueryToMediaItemConnectionPageInfo
Description
Page Info on the "RootQueryToMediaItemConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "xyz789",
"hasNextPage": false,
"hasPreviousPage": false,
"startCursor": "xyz789"
}
RootQueryToMediaItemConnectionWhereArgs
Description
Arguments for filtering the RootQueryToMediaItemConnection connection
Fields
| Input Field | Description |
|---|---|
author - Int
|
The user that's connected as the author of the object. Use the userId for the author object. |
authorIn - [ID]
|
Find objects connected to author(s) in the array of author's userIds |
authorName - String
|
Find objects connected to the author by the author's nicename |
authorNotIn - [ID]
|
Find objects NOT connected to author(s) in the array of author's userIds |
dateQuery - DateQueryInput
|
Filter the connection based on dates |
hasPassword - Boolean
|
True for objects with passwords; False for objects without passwords; null for all objects with or without passwords |
id - Int
|
Specific database ID of the object |
in - [ID]
|
Array of IDs for the objects to retrieve |
language - LanguageCodeFilterEnum
|
Filter by MediaItems by language code (Polylang) |
languages - [LanguageCodeEnum!]
|
Filter MediaItems by one or more languages (Polylang) |
mimeType - MimeTypeEnum
|
Get objects with a specific mimeType property |
name - String
|
Slug / post_name of the object |
nameIn - [String]
|
Specify objects to retrieve. Use slugs |
notIn - [ID]
|
Specify IDs NOT to retrieve. If this is used in the same query as "in", it will be ignored |
orderby - [PostObjectsConnectionOrderbyInput]
|
What parameter to use to order the objects by. |
parent - ID
|
Use ID to return only children. Use 0 to return only top-level items |
parentIn - [ID]
|
Specify objects whose parent is in an array |
parentNotIn - [ID]
|
Specify posts whose parent is not in an array |
password - String
|
Show posts with a specific password. |
search - String
|
Show Posts based on a keyword search |
stati - [PostStatusEnum]
|
Retrieve posts where post status is in an array. |
status - PostStatusEnum
|
Show posts with a specific status. |
title - String
|
Title of the object |
Example
{
"author": 123,
"authorIn": [4],
"authorName": "abc123",
"authorNotIn": [4],
"dateQuery": DateQueryInput,
"hasPassword": false,
"id": 987,
"in": [4],
"language": "ALL",
"languages": ["EN"],
"mimeType": "APPLICATION_MSWORD",
"name": "abc123",
"nameIn": ["xyz789"],
"notIn": [4],
"orderby": [PostObjectsConnectionOrderbyInput],
"parent": 4,
"parentIn": ["4"],
"parentNotIn": ["4"],
"password": "abc123",
"search": "abc123",
"stati": ["ACF_DISABLED"],
"status": "ACF_DISABLED",
"title": "abc123"
}
RootQueryToMenuConnection
Description
Connection between the RootQuery type and the Menu type
Fields
| Field Name | Description |
|---|---|
edges - [RootQueryToMenuConnectionEdge!]!
|
Edges for the RootQueryToMenuConnection connection |
nodes - [Menu!]!
|
The nodes of the connection, without the edges |
pageInfo - RootQueryToMenuConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [RootQueryToMenuConnectionEdge],
"nodes": [Menu],
"pageInfo": RootQueryToMenuConnectionPageInfo
}
RootQueryToMenuConnectionEdge
RootQueryToMenuConnectionPageInfo
Description
Page Info on the "RootQueryToMenuConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "xyz789",
"hasNextPage": true,
"hasPreviousPage": false,
"startCursor": "xyz789"
}
RootQueryToMenuConnectionWhereArgs
Description
Arguments for filtering the RootQueryToMenuConnection connection
Fields
| Input Field | Description |
|---|---|
id - Int
|
The database ID of the object |
location - MenuLocationEnum
|
The menu location for the menu being queried |
slug - String
|
The slug of the menu to query items for |
Example
{
"id": 987,
"location": "PRIMARY",
"slug": "abc123"
}
RootQueryToMenuItemConnection
Description
Connection between the RootQuery type and the MenuItem type
Fields
| Field Name | Description |
|---|---|
edges - [RootQueryToMenuItemConnectionEdge!]!
|
Edges for the RootQueryToMenuItemConnection connection |
nodes - [MenuItem!]!
|
The nodes of the connection, without the edges |
pageInfo - RootQueryToMenuItemConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [RootQueryToMenuItemConnectionEdge],
"nodes": [MenuItem],
"pageInfo": RootQueryToMenuItemConnectionPageInfo
}
RootQueryToMenuItemConnectionEdge
RootQueryToMenuItemConnectionPageInfo
Description
Page Info on the "RootQueryToMenuItemConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "xyz789",
"hasNextPage": false,
"hasPreviousPage": true,
"startCursor": "xyz789"
}
RootQueryToMenuItemConnectionWhereArgs
Description
Arguments for filtering the RootQueryToMenuItemConnection connection
Fields
| Input Field | Description |
|---|---|
id - Int
|
The database ID of the object |
language - LanguageCodeFilterEnum
|
|
location - MenuLocationEnum
|
The menu location for the menu being queried |
parentDatabaseId - Int
|
The database ID of the parent menu object |
parentId - ID
|
The ID of the parent menu object |
Example
{
"id": 987,
"language": "ALL",
"location": "PRIMARY",
"parentDatabaseId": 123,
"parentId": "4"
}
RootQueryToPageConnection
Description
Connection between the RootQuery type and the page type
Fields
| Field Name | Description |
|---|---|
edges - [RootQueryToPageConnectionEdge!]!
|
Edges for the RootQueryToPageConnection connection |
nodes - [Page!]!
|
The nodes of the connection, without the edges |
pageInfo - RootQueryToPageConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [RootQueryToPageConnectionEdge],
"nodes": [Page],
"pageInfo": RootQueryToPageConnectionPageInfo
}
RootQueryToPageConnectionEdge
RootQueryToPageConnectionPageInfo
Description
Page Info on the "RootQueryToPageConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "xyz789",
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "xyz789"
}
RootQueryToPageConnectionWhereArgs
Description
Arguments for filtering the RootQueryToPageConnection connection
Fields
| Input Field | Description |
|---|---|
author - Int
|
The user that's connected as the author of the object. Use the userId for the author object. |
authorIn - [ID]
|
Find objects connected to author(s) in the array of author's userIds |
authorName - String
|
Find objects connected to the author by the author's nicename |
authorNotIn - [ID]
|
Find objects NOT connected to author(s) in the array of author's userIds |
dateQuery - DateQueryInput
|
Filter the connection based on dates |
hasPassword - Boolean
|
True for objects with passwords; False for objects without passwords; null for all objects with or without passwords |
id - Int
|
Specific database ID of the object |
in - [ID]
|
Array of IDs for the objects to retrieve |
language - LanguageCodeFilterEnum
|
Filter by Pages by language code (Polylang) |
languages - [LanguageCodeEnum!]
|
Filter Pages by one or more languages (Polylang) |
mimeType - MimeTypeEnum
|
Get objects with a specific mimeType property |
name - String
|
Slug / post_name of the object |
nameIn - [String]
|
Specify objects to retrieve. Use slugs |
notIn - [ID]
|
Specify IDs NOT to retrieve. If this is used in the same query as "in", it will be ignored |
orderby - [PostObjectsConnectionOrderbyInput]
|
What parameter to use to order the objects by. |
parent - ID
|
Use ID to return only children. Use 0 to return only top-level items |
parentIn - [ID]
|
Specify objects whose parent is in an array |
parentNotIn - [ID]
|
Specify posts whose parent is not in an array |
password - String
|
Show posts with a specific password. |
search - String
|
Show Posts based on a keyword search |
stati - [PostStatusEnum]
|
Retrieve posts where post status is in an array. |
status - PostStatusEnum
|
Show posts with a specific status. |
title - String
|
Title of the object |
Example
{
"author": 123,
"authorIn": [4],
"authorName": "xyz789",
"authorNotIn": ["4"],
"dateQuery": DateQueryInput,
"hasPassword": true,
"id": 987,
"in": [4],
"language": "ALL",
"languages": ["EN"],
"mimeType": "APPLICATION_MSWORD",
"name": "abc123",
"nameIn": ["xyz789"],
"notIn": [4],
"orderby": [PostObjectsConnectionOrderbyInput],
"parent": 4,
"parentIn": ["4"],
"parentNotIn": ["4"],
"password": "abc123",
"search": "abc123",
"stati": ["ACF_DISABLED"],
"status": "ACF_DISABLED",
"title": "xyz789"
}
RootQueryToPluginConnection
Description
Connection between the RootQuery type and the Plugin type
Fields
| Field Name | Description |
|---|---|
edges - [RootQueryToPluginConnectionEdge!]!
|
Edges for the RootQueryToPluginConnection connection |
nodes - [Plugin!]!
|
The nodes of the connection, without the edges |
pageInfo - RootQueryToPluginConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [RootQueryToPluginConnectionEdge],
"nodes": [Plugin],
"pageInfo": RootQueryToPluginConnectionPageInfo
}
RootQueryToPluginConnectionEdge
RootQueryToPluginConnectionPageInfo
Description
Page Info on the "RootQueryToPluginConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "abc123",
"hasNextPage": true,
"hasPreviousPage": false,
"startCursor": "abc123"
}
RootQueryToPluginConnectionWhereArgs
Description
Arguments for filtering the RootQueryToPluginConnection connection
Fields
| Input Field | Description |
|---|---|
search - String
|
Show plugin based on a keyword search. |
stati - [PluginStatusEnum]
|
Retrieve plugins where plugin status is in an array. |
status - PluginStatusEnum
|
Show plugins with a specific status. |
Example
{
"search": "xyz789",
"stati": ["ACTIVE"],
"status": "ACTIVE"
}
RootQueryToPostConnection
Description
Connection between the RootQuery type and the post type
Fields
| Field Name | Description |
|---|---|
edges - [RootQueryToPostConnectionEdge!]!
|
Edges for the RootQueryToPostConnection connection |
nodes - [Post!]!
|
The nodes of the connection, without the edges |
pageInfo - RootQueryToPostConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [RootQueryToPostConnectionEdge],
"nodes": [Post],
"pageInfo": RootQueryToPostConnectionPageInfo
}
RootQueryToPostConnectionEdge
RootQueryToPostConnectionPageInfo
Description
Page Info on the "RootQueryToPostConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "xyz789",
"hasNextPage": true,
"hasPreviousPage": false,
"startCursor": "abc123"
}
RootQueryToPostConnectionWhereArgs
Description
Arguments for filtering the RootQueryToPostConnection connection
Fields
| Input Field | Description |
|---|---|
author - Int
|
The user that's connected as the author of the object. Use the userId for the author object. |
authorIn - [ID]
|
Find objects connected to author(s) in the array of author's userIds |
authorName - String
|
Find objects connected to the author by the author's nicename |
authorNotIn - [ID]
|
Find objects NOT connected to author(s) in the array of author's userIds |
categoryId - Int
|
Category ID |
categoryIn - [ID]
|
Array of category IDs, used to display objects from one category OR another |
categoryName - String
|
Use Category Slug |
categoryNotIn - [ID]
|
Array of category IDs, used to display objects from one category OR another |
dateQuery - DateQueryInput
|
Filter the connection based on dates |
hasPassword - Boolean
|
True for objects with passwords; False for objects without passwords; null for all objects with or without passwords |
id - Int
|
Specific database ID of the object |
in - [ID]
|
Array of IDs for the objects to retrieve |
language - LanguageCodeFilterEnum
|
Filter by Posts by language code (Polylang) |
languages - [LanguageCodeEnum!]
|
Filter Posts by one or more languages (Polylang) |
mimeType - MimeTypeEnum
|
Get objects with a specific mimeType property |
name - String
|
Slug / post_name of the object |
nameIn - [String]
|
Specify objects to retrieve. Use slugs |
notIn - [ID]
|
Specify IDs NOT to retrieve. If this is used in the same query as "in", it will be ignored |
orderby - [PostObjectsConnectionOrderbyInput]
|
What parameter to use to order the objects by. |
parent - ID
|
Use ID to return only children. Use 0 to return only top-level items |
parentIn - [ID]
|
Specify objects whose parent is in an array |
parentNotIn - [ID]
|
Specify posts whose parent is not in an array |
password - String
|
Show posts with a specific password. |
search - String
|
Show Posts based on a keyword search |
stati - [PostStatusEnum]
|
Retrieve posts where post status is in an array. |
status - PostStatusEnum
|
Show posts with a specific status. |
tag - String
|
Tag Slug |
tagId - String
|
Use Tag ID |
tagIn - [ID]
|
Array of tag IDs, used to display objects from one tag OR another |
tagNotIn - [ID]
|
Array of tag IDs, used to display objects from one tag OR another |
tagSlugAnd - [String]
|
Array of tag slugs, used to display objects from one tag AND another |
tagSlugIn - [String]
|
Array of tag slugs, used to include objects in ANY specified tags |
title - String
|
Title of the object |
Example
{
"author": 123,
"authorIn": [4],
"authorName": "abc123",
"authorNotIn": [4],
"categoryId": 987,
"categoryIn": ["4"],
"categoryName": "xyz789",
"categoryNotIn": ["4"],
"dateQuery": DateQueryInput,
"hasPassword": true,
"id": 123,
"in": [4],
"language": "ALL",
"languages": ["EN"],
"mimeType": "APPLICATION_MSWORD",
"name": "abc123",
"nameIn": ["abc123"],
"notIn": [4],
"orderby": [PostObjectsConnectionOrderbyInput],
"parent": "4",
"parentIn": ["4"],
"parentNotIn": [4],
"password": "xyz789",
"search": "xyz789",
"stati": ["ACF_DISABLED"],
"status": "ACF_DISABLED",
"tag": "abc123",
"tagId": "xyz789",
"tagIn": [4],
"tagNotIn": [4],
"tagSlugAnd": ["xyz789"],
"tagSlugIn": ["xyz789"],
"title": "abc123"
}
RootQueryToPostFormatConnection
Description
Connection between the RootQuery type and the postFormat type
Fields
| Field Name | Description |
|---|---|
edges - [RootQueryToPostFormatConnectionEdge!]!
|
Edges for the RootQueryToPostFormatConnection connection |
nodes - [PostFormat!]!
|
The nodes of the connection, without the edges |
pageInfo - RootQueryToPostFormatConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [RootQueryToPostFormatConnectionEdge],
"nodes": [PostFormat],
"pageInfo": RootQueryToPostFormatConnectionPageInfo
}
RootQueryToPostFormatConnectionEdge
Description
An edge in a connection
Fields
| Field Name | Description |
|---|---|
cursor - String
|
A cursor for use in pagination |
node - PostFormat!
|
The item at the end of the edge |
Example
{
"cursor": "abc123",
"node": PostFormat
}
RootQueryToPostFormatConnectionPageInfo
Description
Page Info on the "RootQueryToPostFormatConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "abc123",
"hasNextPage": true,
"hasPreviousPage": false,
"startCursor": "xyz789"
}
RootQueryToPostFormatConnectionWhereArgs
Description
Arguments for filtering the RootQueryToPostFormatConnection connection
Fields
| Input Field | Description |
|---|---|
cacheDomain - String
|
Unique cache key to be produced when this query is stored in an object cache. Default is 'core'. |
childOf - Int
|
Term ID to retrieve child terms of. If multiple taxonomies are passed, $child_of is ignored. Default 0. |
childless - Boolean
|
True to limit results to terms that have no children. This parameter has no effect on non-hierarchical taxonomies. Default false. |
descriptionLike - String
|
Retrieve terms where the description is LIKE the input value. Default empty. |
exclude - [ID]
|
Array of term ids to exclude. If $include is non-empty, $exclude is ignored. Default empty array. |
excludeTree - [ID]
|
Array of term ids to exclude along with all of their descendant terms. If $include is non-empty, $exclude_tree is ignored. Default empty array. |
hideEmpty - Boolean
|
Whether to hide terms not assigned to any posts. Accepts true or false. Default false |
hierarchical - Boolean
|
Whether to include terms that have non-empty descendants (even if $hide_empty is set to true). Default true. |
include - [ID]
|
Array of term ids to include. Default empty array. |
name - [String]
|
Array of names to return term(s) for. Default empty. |
nameLike - String
|
Retrieve terms where the name is LIKE the input value. Default empty. |
objectIds - [ID]
|
Array of object IDs. Results will be limited to terms associated with these objects. |
order - OrderEnum
|
Direction the connection should be ordered in |
orderby - TermObjectsConnectionOrderbyEnum
|
Field(s) to order terms by. Defaults to 'name'. |
padCounts - Boolean
|
Whether to pad the quantity of a term's children in the quantity of each term's "count" object variable. Default false. |
parent - Int
|
Parent term ID to retrieve direct-child terms of. Default empty. |
search - String
|
Search criteria to match terms. Will be SQL-formatted with wildcards before and after. Default empty. |
slug - [String]
|
Array of slugs to return term(s) for. Default empty. |
termTaxonomId - [ID]
|
Array of term taxonomy IDs, to match when querying terms. |
termTaxonomyId - [ID]
|
Array of term taxonomy IDs, to match when querying terms. |
updateTermMetaCache - Boolean
|
Whether to prime meta caches for matched terms. Default true. |
Example
{
"cacheDomain": "xyz789",
"childOf": 987,
"childless": true,
"descriptionLike": "abc123",
"exclude": ["4"],
"excludeTree": ["4"],
"hideEmpty": false,
"hierarchical": false,
"include": ["4"],
"name": ["abc123"],
"nameLike": "abc123",
"objectIds": ["4"],
"order": "ASC",
"orderby": "COUNT",
"padCounts": true,
"parent": 987,
"search": "abc123",
"slug": ["abc123"],
"termTaxonomId": [4],
"termTaxonomyId": ["4"],
"updateTermMetaCache": false
}
RootQueryToReleaseConnection
Description
Connection between the RootQuery type and the release type
Fields
| Field Name | Description |
|---|---|
edges - [RootQueryToReleaseConnectionEdge!]!
|
Edges for the RootQueryToReleaseConnection connection |
nodes - [Release!]!
|
The nodes of the connection, without the edges |
pageInfo - RootQueryToReleaseConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [RootQueryToReleaseConnectionEdge],
"nodes": [Release],
"pageInfo": RootQueryToReleaseConnectionPageInfo
}
RootQueryToReleaseConnectionEdge
RootQueryToReleaseConnectionPageInfo
Description
Page Info on the "RootQueryToReleaseConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "xyz789",
"hasNextPage": true,
"hasPreviousPage": false,
"startCursor": "abc123"
}
RootQueryToReleaseConnectionWhereArgs
Description
Arguments for filtering the RootQueryToReleaseConnection connection
Fields
| Input Field | Description |
|---|---|
dateQuery - DateQueryInput
|
Filter the connection based on dates |
hasPassword - Boolean
|
True for objects with passwords; False for objects without passwords; null for all objects with or without passwords |
id - Int
|
Specific database ID of the object |
in - [ID]
|
Array of IDs for the objects to retrieve |
language - LanguageCodeFilterEnum
|
Filter by Releases by language code (Polylang) |
languages - [LanguageCodeEnum!]
|
Filter Releases by one or more languages (Polylang) |
mimeType - MimeTypeEnum
|
Get objects with a specific mimeType property |
name - String
|
Slug / post_name of the object |
nameIn - [String]
|
Specify objects to retrieve. Use slugs |
notIn - [ID]
|
Specify IDs NOT to retrieve. If this is used in the same query as "in", it will be ignored |
orderby - [PostObjectsConnectionOrderbyInput]
|
What parameter to use to order the objects by. |
parent - ID
|
Use ID to return only children. Use 0 to return only top-level items |
parentIn - [ID]
|
Specify objects whose parent is in an array |
parentNotIn - [ID]
|
Specify posts whose parent is not in an array |
password - String
|
Show posts with a specific password. |
search - String
|
Show Posts based on a keyword search |
stati - [PostStatusEnum]
|
Retrieve posts where post status is in an array. |
status - PostStatusEnum
|
Show posts with a specific status. |
title - String
|
Title of the object |
Example
{
"dateQuery": DateQueryInput,
"hasPassword": true,
"id": 123,
"in": ["4"],
"language": "ALL",
"languages": ["EN"],
"mimeType": "APPLICATION_MSWORD",
"name": "xyz789",
"nameIn": ["xyz789"],
"notIn": ["4"],
"orderby": [PostObjectsConnectionOrderbyInput],
"parent": 4,
"parentIn": [4],
"parentNotIn": [4],
"password": "xyz789",
"search": "xyz789",
"stati": ["ACF_DISABLED"],
"status": "ACF_DISABLED",
"title": "abc123"
}
RootQueryToRevisionsConnection
Description
Connection between the RootQuery type and the ContentNode type
Fields
| Field Name | Description |
|---|---|
edges - [RootQueryToRevisionsConnectionEdge!]!
|
Edges for the RootQueryToRevisionsConnection connection |
nodes - [ContentNode!]!
|
The nodes of the connection, without the edges |
pageInfo - RootQueryToRevisionsConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [RootQueryToRevisionsConnectionEdge],
"nodes": [ContentNode],
"pageInfo": RootQueryToRevisionsConnectionPageInfo
}
RootQueryToRevisionsConnectionEdge
Description
An edge in a connection
Fields
| Field Name | Description |
|---|---|
cursor - String
|
A cursor for use in pagination |
node - ContentNode!
|
The item at the end of the edge |
Example
{
"cursor": "abc123",
"node": ContentNode
}
RootQueryToRevisionsConnectionPageInfo
Description
Page Info on the "RootQueryToRevisionsConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "xyz789",
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "abc123"
}
RootQueryToRevisionsConnectionWhereArgs
Description
Arguments for filtering the RootQueryToRevisionsConnection connection
Fields
| Input Field | Description |
|---|---|
contentTypes - [ContentTypeEnum]
|
The Types of content to filter |
dateQuery - DateQueryInput
|
Filter the connection based on dates |
hasPassword - Boolean
|
True for objects with passwords; False for objects without passwords; null for all objects with or without passwords |
id - Int
|
Specific database ID of the object |
in - [ID]
|
Array of IDs for the objects to retrieve |
mimeType - MimeTypeEnum
|
Get objects with a specific mimeType property |
name - String
|
Slug / post_name of the object |
nameIn - [String]
|
Specify objects to retrieve. Use slugs |
notIn - [ID]
|
Specify IDs NOT to retrieve. If this is used in the same query as "in", it will be ignored |
orderby - [PostObjectsConnectionOrderbyInput]
|
What parameter to use to order the objects by. |
parent - ID
|
Use ID to return only children. Use 0 to return only top-level items |
parentIn - [ID]
|
Specify objects whose parent is in an array |
parentNotIn - [ID]
|
Specify posts whose parent is not in an array |
password - String
|
Show posts with a specific password. |
search - String
|
Show Posts based on a keyword search |
stati - [PostStatusEnum]
|
Retrieve posts where post status is in an array. |
status - PostStatusEnum
|
Show posts with a specific status. |
title - String
|
Title of the object |
Example
{
"contentTypes": ["ATTACHMENT"],
"dateQuery": DateQueryInput,
"hasPassword": true,
"id": 123,
"in": ["4"],
"mimeType": "APPLICATION_MSWORD",
"name": "xyz789",
"nameIn": ["xyz789"],
"notIn": [4],
"orderby": [PostObjectsConnectionOrderbyInput],
"parent": "4",
"parentIn": ["4"],
"parentNotIn": [4],
"password": "xyz789",
"search": "xyz789",
"stati": ["ACF_DISABLED"],
"status": "ACF_DISABLED",
"title": "abc123"
}
RootQueryToTagConnection
Description
Connection between the RootQuery type and the tag type
Fields
| Field Name | Description |
|---|---|
edges - [RootQueryToTagConnectionEdge!]!
|
Edges for the RootQueryToTagConnection connection |
nodes - [Tag!]!
|
The nodes of the connection, without the edges |
pageInfo - RootQueryToTagConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [RootQueryToTagConnectionEdge],
"nodes": [Tag],
"pageInfo": RootQueryToTagConnectionPageInfo
}
RootQueryToTagConnectionEdge
RootQueryToTagConnectionPageInfo
Description
Page Info on the "RootQueryToTagConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "abc123",
"hasNextPage": true,
"hasPreviousPage": false,
"startCursor": "abc123"
}
RootQueryToTagConnectionWhereArgs
Description
Arguments for filtering the RootQueryToTagConnection connection
Fields
| Input Field | Description |
|---|---|
cacheDomain - String
|
Unique cache key to be produced when this query is stored in an object cache. Default is 'core'. |
childOf - Int
|
Term ID to retrieve child terms of. If multiple taxonomies are passed, $child_of is ignored. Default 0. |
childless - Boolean
|
True to limit results to terms that have no children. This parameter has no effect on non-hierarchical taxonomies. Default false. |
descriptionLike - String
|
Retrieve terms where the description is LIKE the input value. Default empty. |
exclude - [ID]
|
Array of term ids to exclude. If $include is non-empty, $exclude is ignored. Default empty array. |
excludeTree - [ID]
|
Array of term ids to exclude along with all of their descendant terms. If $include is non-empty, $exclude_tree is ignored. Default empty array. |
hideEmpty - Boolean
|
Whether to hide terms not assigned to any posts. Accepts true or false. Default false |
hierarchical - Boolean
|
Whether to include terms that have non-empty descendants (even if $hide_empty is set to true). Default true. |
include - [ID]
|
Array of term ids to include. Default empty array. |
language - LanguageCodeFilterEnum
|
Filter by Tags by language code (Polylang) |
languages - [LanguageCodeEnum!]
|
Filter Tags by one or more languages (Polylang) |
name - [String]
|
Array of names to return term(s) for. Default empty. |
nameLike - String
|
Retrieve terms where the name is LIKE the input value. Default empty. |
objectIds - [ID]
|
Array of object IDs. Results will be limited to terms associated with these objects. |
order - OrderEnum
|
Direction the connection should be ordered in |
orderby - TermObjectsConnectionOrderbyEnum
|
Field(s) to order terms by. Defaults to 'name'. |
padCounts - Boolean
|
Whether to pad the quantity of a term's children in the quantity of each term's "count" object variable. Default false. |
parent - Int
|
Parent term ID to retrieve direct-child terms of. Default empty. |
search - String
|
Search criteria to match terms. Will be SQL-formatted with wildcards before and after. Default empty. |
slug - [String]
|
Array of slugs to return term(s) for. Default empty. |
termTaxonomId - [ID]
|
Array of term taxonomy IDs, to match when querying terms. |
termTaxonomyId - [ID]
|
Array of term taxonomy IDs, to match when querying terms. |
updateTermMetaCache - Boolean
|
Whether to prime meta caches for matched terms. Default true. |
Example
{
"cacheDomain": "abc123",
"childOf": 987,
"childless": true,
"descriptionLike": "abc123",
"exclude": ["4"],
"excludeTree": ["4"],
"hideEmpty": false,
"hierarchical": false,
"include": ["4"],
"language": "ALL",
"languages": ["EN"],
"name": ["xyz789"],
"nameLike": "xyz789",
"objectIds": ["4"],
"order": "ASC",
"orderby": "COUNT",
"padCounts": false,
"parent": 987,
"search": "xyz789",
"slug": ["xyz789"],
"termTaxonomId": [4],
"termTaxonomyId": [4],
"updateTermMetaCache": false
}
RootQueryToTaxonomyConnection
Description
Connection between the RootQuery type and the Taxonomy type
Fields
| Field Name | Description |
|---|---|
edges - [RootQueryToTaxonomyConnectionEdge!]!
|
Edges for the RootQueryToTaxonomyConnection connection |
nodes - [Taxonomy!]!
|
The nodes of the connection, without the edges |
pageInfo - RootQueryToTaxonomyConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [RootQueryToTaxonomyConnectionEdge],
"nodes": [Taxonomy],
"pageInfo": RootQueryToTaxonomyConnectionPageInfo
}
RootQueryToTaxonomyConnectionEdge
RootQueryToTaxonomyConnectionPageInfo
Description
Page Info on the "RootQueryToTaxonomyConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "xyz789",
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "abc123"
}
RootQueryToTermNodeConnection
Description
Connection between the RootQuery type and the TermNode type
Fields
| Field Name | Description |
|---|---|
edges - [RootQueryToTermNodeConnectionEdge!]!
|
Edges for the RootQueryToTermNodeConnection connection |
nodes - [TermNode!]!
|
The nodes of the connection, without the edges |
pageInfo - RootQueryToTermNodeConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [RootQueryToTermNodeConnectionEdge],
"nodes": [TermNode],
"pageInfo": RootQueryToTermNodeConnectionPageInfo
}
RootQueryToTermNodeConnectionEdge
RootQueryToTermNodeConnectionPageInfo
Description
Page Info on the "RootQueryToTermNodeConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "xyz789",
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "abc123"
}
RootQueryToTermNodeConnectionWhereArgs
Description
Arguments for filtering the RootQueryToTermNodeConnection connection
Fields
| Input Field | Description |
|---|---|
cacheDomain - String
|
Unique cache key to be produced when this query is stored in an object cache. Default is 'core'. |
childOf - Int
|
Term ID to retrieve child terms of. If multiple taxonomies are passed, $child_of is ignored. Default 0. |
childless - Boolean
|
True to limit results to terms that have no children. This parameter has no effect on non-hierarchical taxonomies. Default false. |
descriptionLike - String
|
Retrieve terms where the description is LIKE the input value. Default empty. |
exclude - [ID]
|
Array of term ids to exclude. If $include is non-empty, $exclude is ignored. Default empty array. |
excludeTree - [ID]
|
Array of term ids to exclude along with all of their descendant terms. If $include is non-empty, $exclude_tree is ignored. Default empty array. |
hideEmpty - Boolean
|
Whether to hide terms not assigned to any posts. Accepts true or false. Default false |
hierarchical - Boolean
|
Whether to include terms that have non-empty descendants (even if $hide_empty is set to true). Default true. |
include - [ID]
|
Array of term ids to include. Default empty array. |
name - [String]
|
Array of names to return term(s) for. Default empty. |
nameLike - String
|
Retrieve terms where the name is LIKE the input value. Default empty. |
objectIds - [ID]
|
Array of object IDs. Results will be limited to terms associated with these objects. |
order - OrderEnum
|
Direction the connection should be ordered in |
orderby - TermObjectsConnectionOrderbyEnum
|
Field(s) to order terms by. Defaults to 'name'. |
padCounts - Boolean
|
Whether to pad the quantity of a term's children in the quantity of each term's "count" object variable. Default false. |
parent - Int
|
Parent term ID to retrieve direct-child terms of. Default empty. |
search - String
|
Search criteria to match terms. Will be SQL-formatted with wildcards before and after. Default empty. |
slug - [String]
|
Array of slugs to return term(s) for. Default empty. |
taxonomies - [TaxonomyEnum]
|
The Taxonomy to filter terms by |
termTaxonomId - [ID]
|
Array of term taxonomy IDs, to match when querying terms. |
termTaxonomyId - [ID]
|
Array of term taxonomy IDs, to match when querying terms. |
updateTermMetaCache - Boolean
|
Whether to prime meta caches for matched terms. Default true. |
Example
{
"cacheDomain": "xyz789",
"childOf": 123,
"childless": true,
"descriptionLike": "xyz789",
"exclude": ["4"],
"excludeTree": ["4"],
"hideEmpty": false,
"hierarchical": true,
"include": [4],
"name": ["abc123"],
"nameLike": "abc123",
"objectIds": ["4"],
"order": "ASC",
"orderby": "COUNT",
"padCounts": false,
"parent": 123,
"search": "xyz789",
"slug": ["xyz789"],
"taxonomies": ["CATEGORY"],
"termTaxonomId": ["4"],
"termTaxonomyId": [4],
"updateTermMetaCache": false
}
RootQueryToThemeConnection
Description
Connection between the RootQuery type and the Theme type
Fields
| Field Name | Description |
|---|---|
edges - [RootQueryToThemeConnectionEdge!]!
|
Edges for the RootQueryToThemeConnection connection |
nodes - [Theme!]!
|
The nodes of the connection, without the edges |
pageInfo - RootQueryToThemeConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [RootQueryToThemeConnectionEdge],
"nodes": [Theme],
"pageInfo": RootQueryToThemeConnectionPageInfo
}
RootQueryToThemeConnectionEdge
RootQueryToThemeConnectionPageInfo
Description
Page Info on the "RootQueryToThemeConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "xyz789",
"hasNextPage": false,
"hasPreviousPage": false,
"startCursor": "xyz789"
}
RootQueryToTranslationConnection
Description
Connection between the RootQuery type and the translation type
Fields
| Field Name | Description |
|---|---|
edges - [RootQueryToTranslationConnectionEdge!]!
|
Edges for the RootQueryToTranslationConnection connection |
nodes - [Translation!]!
|
The nodes of the connection, without the edges |
pageInfo - RootQueryToTranslationConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [RootQueryToTranslationConnectionEdge],
"nodes": [Translation],
"pageInfo": RootQueryToTranslationConnectionPageInfo
}
RootQueryToTranslationConnectionEdge
Description
An edge in a connection
Fields
| Field Name | Description |
|---|---|
cursor - String
|
A cursor for use in pagination |
node - Translation!
|
The item at the end of the edge |
Example
{
"cursor": "xyz789",
"node": Translation
}
RootQueryToTranslationConnectionPageInfo
Description
Page Info on the "RootQueryToTranslationConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "xyz789",
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "xyz789"
}
RootQueryToTranslationConnectionWhereArgs
Description
Arguments for filtering the RootQueryToTranslationConnection connection
Fields
| Input Field | Description |
|---|---|
dateQuery - DateQueryInput
|
Filter the connection based on dates |
hasPassword - Boolean
|
True for objects with passwords; False for objects without passwords; null for all objects with or without passwords |
id - Int
|
Specific database ID of the object |
in - [ID]
|
Array of IDs for the objects to retrieve |
mimeType - MimeTypeEnum
|
Get objects with a specific mimeType property |
name - String
|
Slug / post_name of the object |
nameIn - [String]
|
Specify objects to retrieve. Use slugs |
notIn - [ID]
|
Specify IDs NOT to retrieve. If this is used in the same query as "in", it will be ignored |
orderby - [PostObjectsConnectionOrderbyInput]
|
What parameter to use to order the objects by. |
parent - ID
|
Use ID to return only children. Use 0 to return only top-level items |
parentIn - [ID]
|
Specify objects whose parent is in an array |
parentNotIn - [ID]
|
Specify posts whose parent is not in an array |
password - String
|
Show posts with a specific password. |
search - String
|
Show Posts based on a keyword search |
stati - [PostStatusEnum]
|
Retrieve posts where post status is in an array. |
status - PostStatusEnum
|
Show posts with a specific status. |
title - String
|
Title of the object |
Example
{
"dateQuery": DateQueryInput,
"hasPassword": true,
"id": 987,
"in": [4],
"mimeType": "APPLICATION_MSWORD",
"name": "abc123",
"nameIn": ["xyz789"],
"notIn": ["4"],
"orderby": [PostObjectsConnectionOrderbyInput],
"parent": 4,
"parentIn": ["4"],
"parentNotIn": [4],
"password": "abc123",
"search": "xyz789",
"stati": ["ACF_DISABLED"],
"status": "ACF_DISABLED",
"title": "abc123"
}
RootQueryToUserConnection
Description
Connection between the RootQuery type and the User type
Fields
| Field Name | Description |
|---|---|
edges - [RootQueryToUserConnectionEdge!]!
|
Edges for the RootQueryToUserConnection connection |
nodes - [User!]!
|
The nodes of the connection, without the edges |
pageInfo - RootQueryToUserConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [RootQueryToUserConnectionEdge],
"nodes": [User],
"pageInfo": RootQueryToUserConnectionPageInfo
}
RootQueryToUserConnectionEdge
RootQueryToUserConnectionPageInfo
Description
Page Info on the "RootQueryToUserConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "xyz789",
"hasNextPage": false,
"hasPreviousPage": false,
"startCursor": "xyz789"
}
RootQueryToUserConnectionWhereArgs
Description
Arguments for filtering the RootQueryToUserConnection connection
Fields
| Input Field | Description |
|---|---|
exclude - [Int]
|
Array of userIds to exclude. |
hasPublishedPosts - [ContentTypeEnum]
|
Pass an array of post types to filter results to users who have published posts in those post types. |
include - [Int]
|
Array of userIds to include. |
login - String
|
The user login. |
loginIn - [String]
|
An array of logins to include. Users matching one of these logins will be included in results. |
loginNotIn - [String]
|
An array of logins to exclude. Users matching one of these logins will not be included in results. |
nicename - String
|
The user nicename. |
nicenameIn - [String]
|
An array of nicenames to include. Users matching one of these nicenames will be included in results. |
nicenameNotIn - [String]
|
An array of nicenames to exclude. Users matching one of these nicenames will not be included in results. |
orderby - [UsersConnectionOrderbyInput]
|
What parameter to use to order the objects by. |
role - UserRoleEnum
|
An array of role names that users must match to be included in results. Note that this is an inclusive list: users must match each role. |
roleIn - [UserRoleEnum]
|
An array of role names. Matched users must have at least one of these roles. |
roleNotIn - [UserRoleEnum]
|
An array of role names to exclude. Users matching one or more of these roles will not be included in results. |
search - String
|
Search keyword. Searches for possible string matches on columns. When "searchColumns" is left empty, it tries to determine which column to search in based on search string. |
searchColumns - [UsersConnectionSearchColumnEnum]
|
Array of column names to be searched. Accepts 'ID', 'login', 'nicename', 'email', 'url'. |
Example
{
"exclude": [987],
"hasPublishedPosts": ["ATTACHMENT"],
"include": [987],
"login": "abc123",
"loginIn": ["xyz789"],
"loginNotIn": ["xyz789"],
"nicename": "abc123",
"nicenameIn": ["abc123"],
"nicenameNotIn": ["abc123"],
"orderby": [UsersConnectionOrderbyInput],
"role": "ADMINISTRATOR",
"roleIn": ["ADMINISTRATOR"],
"roleNotIn": ["ADMINISTRATOR"],
"search": "xyz789",
"searchColumns": ["EMAIL"]
}
RootQueryToUserRoleConnection
Description
Connection between the RootQuery type and the UserRole type
Fields
| Field Name | Description |
|---|---|
edges - [RootQueryToUserRoleConnectionEdge!]!
|
Edges for the RootQueryToUserRoleConnection connection |
nodes - [UserRole!]!
|
The nodes of the connection, without the edges |
pageInfo - RootQueryToUserRoleConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [RootQueryToUserRoleConnectionEdge],
"nodes": [UserRole],
"pageInfo": RootQueryToUserRoleConnectionPageInfo
}
RootQueryToUserRoleConnectionEdge
RootQueryToUserRoleConnectionPageInfo
Description
Page Info on the "RootQueryToUserRoleConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "xyz789",
"hasNextPage": false,
"hasPreviousPage": true,
"startCursor": "abc123"
}
SEO
Fields
| Field Name | Description |
|---|---|
canonicalUrl - String
|
Canonical URL |
description - String
|
SEO Description |
excludeFromArchive - Boolean
|
Whether this page should be excluded from all archive queries |
excludeLocalSearch - Boolean
|
Whether this page should be excluded from all search queries |
noArchive - Boolean
|
Whether search engines should show cached links of this page |
noFollow - Boolean
|
Whether search engines should follow the links of this page |
noIndex - Boolean
|
Whether search engines should index this page |
openGraphDescription - String
|
Open Graph description |
openGraphTitle - String
|
Open Graph title |
openGraphType - String
|
Open Graph type ('website', 'article', ...) |
redirectUrl - String
|
301 redirect URL to force visitors to another page |
removeSiteTitle - Boolean
|
If true, site title is/should not be added to the end of the SEO title |
socialImage - MediaItem
|
|
title - String
|
SEO Title |
twitterDescription - String
|
Twitter description |
twitterTitle - String
|
Twitter title |
Example
{
"canonicalUrl": "abc123",
"description": "xyz789",
"excludeFromArchive": true,
"excludeLocalSearch": false,
"noArchive": false,
"noFollow": false,
"noIndex": false,
"openGraphDescription": "abc123",
"openGraphTitle": "xyz789",
"openGraphType": "xyz789",
"redirectUrl": "abc123",
"removeSiteTitle": false,
"socialImage": MediaItem,
"title": "xyz789",
"twitterDescription": "xyz789",
"twitterTitle": "xyz789"
}
ScriptLoadingStrategyEnum
Description
The strategy to use when loading the script
Values
| Enum Value | Description |
|---|---|
|
|
Use the script async attribute |
|
|
Use the script defer attribute |
Example
"ASYNC"
SendPasswordResetEmailInput
Description
Input for the sendPasswordResetEmail mutation.
Example
{
"clientMutationId": "xyz789",
"username": "xyz789"
}
SendPasswordResetEmailPayload
Description
The payload for the sendPasswordResetEmail mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
If a 'clientMutationId' input is provided to the mutation, it will be returned as output on the mutation. This ID can be used by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
success - Boolean
|
Whether the mutation completed successfully. This does NOT necessarily mean that an email was sent. |
user - User
|
The user that the password reset email was sent to This field will be removed in a future version of WPGraphQL |
Example
{
"clientMutationId": "abc123",
"success": false,
"user": User
}
SeoSettings
Fields
| Field Name | Description |
|---|---|
separator - String
|
Title separator setting for seo titles |
Example
{"separator": "xyz789"}
Settings
Description
All of the registered settings
Fields
| Field Name | Description |
|---|---|
discussionSettingsDefaultCommentStatus - String
|
Settings of the the string Settings Group |
discussionSettingsDefaultPingStatus - String
|
Settings of the the string Settings Group |
generalSettingsDateFormat - String
|
Settings of the the string Settings Group |
generalSettingsDescription - String
|
Settings of the the string Settings Group |
generalSettingsLanguage - String
|
Settings of the the string Settings Group |
generalSettingsStartOfWeek - Int
|
Settings of the the integer Settings Group |
generalSettingsTimeFormat - String
|
Settings of the the string Settings Group |
generalSettingsTimezone - String
|
Settings of the the string Settings Group |
generalSettingsTitle - String
|
Settings of the the string Settings Group |
readingSettingsPageForPosts - Int
|
Settings of the the integer Settings Group |
readingSettingsPageOnFront - Int
|
Settings of the the integer Settings Group |
readingSettingsPostsPerPage - Int
|
Settings of the the integer Settings Group |
readingSettingsShowOnFront - String
|
Settings of the the string Settings Group |
writingSettingsDefaultCategory - Int
|
Settings of the the integer Settings Group |
writingSettingsDefaultPostFormat - String
|
Settings of the the string Settings Group |
writingSettingsUseSmilies - Boolean
|
Settings of the the boolean Settings Group |
Example
{
"discussionSettingsDefaultCommentStatus": "xyz789",
"discussionSettingsDefaultPingStatus": "abc123",
"generalSettingsDateFormat": "abc123",
"generalSettingsDescription": "abc123",
"generalSettingsLanguage": "xyz789",
"generalSettingsStartOfWeek": 987,
"generalSettingsTimeFormat": "abc123",
"generalSettingsTimezone": "xyz789",
"generalSettingsTitle": "abc123",
"readingSettingsPageForPosts": 123,
"readingSettingsPageOnFront": 123,
"readingSettingsPostsPerPage": 123,
"readingSettingsShowOnFront": "xyz789",
"writingSettingsDefaultCategory": 123,
"writingSettingsDefaultPostFormat": "xyz789",
"writingSettingsUseSmilies": false
}
SiteSettings
Step
String
Description
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
"xyz789"
Tag
Description
The tag type
Fields
| Field Name | Description |
|---|---|
contentNodes - TagToContentNodeConnection
|
Connection between the Tag type and the ContentNode type |
Arguments
|
|
count - Int
|
The number of objects connected to the object |
databaseId - Int!
|
The unique identifier stored in the database |
description - String
|
The description of the object |
enqueuedScripts - TermNodeToEnqueuedScriptConnection
|
Connection between the TermNode type and the EnqueuedScript type |
Arguments
|
|
enqueuedStylesheets - TermNodeToEnqueuedStylesheetConnection
|
Connection between the TermNode type and the EnqueuedStylesheet type |
Arguments
|
|
id - ID!
|
The globally unique ID for the object |
isComment - Boolean!
|
Whether the node is a Comment |
isContentNode - Boolean!
|
Whether the node is a Content Node |
isFrontPage - Boolean!
|
Whether the node represents the front page. |
isPostsPage - Boolean!
|
Whether the node represents the blog page. |
isRestricted - Boolean
|
Whether the object is restricted from the current viewer |
isTermNode - Boolean!
|
Whether the node is a Term |
language - Language
|
List available translations for this post |
link - String
|
The link to the term |
name - String
|
The human friendly name of the object. |
posts - TagToPostConnection
|
Connection between the Tag type and the post type |
Arguments
|
|
slug - String
|
An alphanumeric identifier for the object unique to its type. |
tagId - Int
|
The id field matches the WP_Post->ID field. Deprecated in favor of databaseId |
taxonomy - TagToTaxonomyConnectionEdge
|
Connection between the Tag type and the Taxonomy type |
taxonomyName - String
|
The name of the taxonomy that the object is associated with |
termGroupId - Int
|
The ID of the term group that this term object belongs to |
termTaxonomyId - Int
|
The taxonomy ID that the object is associated with |
translation - Tag
|
Get specific translation version of this object |
Arguments
|
|
translations - [Tag]
|
List all translated versions of this term |
uri - String
|
The unique resource identifier path |
Example
{
"contentNodes": TagToContentNodeConnection,
"count": 123,
"databaseId": 123,
"description": "abc123",
"enqueuedScripts": TermNodeToEnqueuedScriptConnection,
"enqueuedStylesheets": TermNodeToEnqueuedStylesheetConnection,
"id": 4,
"isComment": true,
"isContentNode": true,
"isFrontPage": false,
"isPostsPage": false,
"isRestricted": true,
"isTermNode": true,
"language": Language,
"link": "xyz789",
"name": "xyz789",
"posts": TagToPostConnection,
"slug": "xyz789",
"tagId": 123,
"taxonomy": TagToTaxonomyConnectionEdge,
"taxonomyName": "abc123",
"termGroupId": 987,
"termTaxonomyId": 987,
"translation": Tag,
"translations": [Tag],
"uri": "xyz789"
}
TagConnection
Description
Connection to tag Nodes
Fields
| Field Name | Description |
|---|---|
edges - [TagConnectionEdge!]!
|
A list of edges (relational context) between RootQuery and connected tag Nodes |
nodes - [Tag!]!
|
A list of connected tag Nodes |
pageInfo - TagConnectionPageInfo!
|
Information about pagination in a connection. |
Possible Types
| TagConnection Types |
|---|
Example
{
"edges": [TagConnectionEdge],
"nodes": [Tag],
"pageInfo": TagConnectionPageInfo
}
TagConnectionEdge
Description
Edge between a Node and a connected tag
Fields
| Field Name | Description |
|---|---|
cursor - String
|
Opaque reference to the nodes position in the connection. Value can be used with pagination args. |
node - Tag!
|
The connected tag Node |
Possible Types
| TagConnectionEdge Types |
|---|
Example
{
"cursor": "abc123",
"node": Tag
}
TagConnectionPageInfo
Description
Page Info on the connected TagConnectionEdge
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Possible Types
| TagConnectionPageInfo Types |
|---|
Example
{
"endCursor": "xyz789",
"hasNextPage": false,
"hasPreviousPage": true,
"startCursor": "xyz789"
}
TagIdType
Description
The Type of Identifier used to fetch a single resource. Default is ID.
Values
| Enum Value | Description |
|---|---|
|
|
The Database ID for the node |
|
|
The hashed Global ID |
|
|
The name of the node |
|
|
Url friendly name of the node |
|
|
The URI for the node |
Example
"DATABASE_ID"
TagToContentNodeConnection
Description
Connection between the Tag type and the ContentNode type
Fields
| Field Name | Description |
|---|---|
edges - [TagToContentNodeConnectionEdge!]!
|
Edges for the TagToContentNodeConnection connection |
nodes - [ContentNode!]!
|
The nodes of the connection, without the edges |
pageInfo - TagToContentNodeConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [TagToContentNodeConnectionEdge],
"nodes": [ContentNode],
"pageInfo": TagToContentNodeConnectionPageInfo
}
TagToContentNodeConnectionEdge
Description
An edge in a connection
Fields
| Field Name | Description |
|---|---|
cursor - String
|
A cursor for use in pagination |
node - ContentNode!
|
The item at the end of the edge |
Example
{
"cursor": "xyz789",
"node": ContentNode
}
TagToContentNodeConnectionPageInfo
Description
Page Info on the "TagToContentNodeConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "xyz789",
"hasNextPage": true,
"hasPreviousPage": false,
"startCursor": "xyz789"
}
TagToContentNodeConnectionWhereArgs
Description
Arguments for filtering the TagToContentNodeConnection connection
Fields
| Input Field | Description |
|---|---|
contentTypes - [ContentTypesOfTagEnum]
|
The Types of content to filter |
dateQuery - DateQueryInput
|
Filter the connection based on dates |
hasPassword - Boolean
|
True for objects with passwords; False for objects without passwords; null for all objects with or without passwords |
id - Int
|
Specific database ID of the object |
in - [ID]
|
Array of IDs for the objects to retrieve |
mimeType - MimeTypeEnum
|
Get objects with a specific mimeType property |
name - String
|
Slug / post_name of the object |
nameIn - [String]
|
Specify objects to retrieve. Use slugs |
notIn - [ID]
|
Specify IDs NOT to retrieve. If this is used in the same query as "in", it will be ignored |
orderby - [PostObjectsConnectionOrderbyInput]
|
What parameter to use to order the objects by. |
parent - ID
|
Use ID to return only children. Use 0 to return only top-level items |
parentIn - [ID]
|
Specify objects whose parent is in an array |
parentNotIn - [ID]
|
Specify posts whose parent is not in an array |
password - String
|
Show posts with a specific password. |
search - String
|
Show Posts based on a keyword search |
stati - [PostStatusEnum]
|
Retrieve posts where post status is in an array. |
status - PostStatusEnum
|
Show posts with a specific status. |
title - String
|
Title of the object |
Example
{
"contentTypes": ["POST"],
"dateQuery": DateQueryInput,
"hasPassword": true,
"id": 987,
"in": ["4"],
"mimeType": "APPLICATION_MSWORD",
"name": "xyz789",
"nameIn": ["xyz789"],
"notIn": [4],
"orderby": [PostObjectsConnectionOrderbyInput],
"parent": "4",
"parentIn": [4],
"parentNotIn": ["4"],
"password": "abc123",
"search": "xyz789",
"stati": ["ACF_DISABLED"],
"status": "ACF_DISABLED",
"title": "xyz789"
}
TagToPostConnection
Description
Connection between the Tag type and the post type
Fields
| Field Name | Description |
|---|---|
edges - [TagToPostConnectionEdge!]!
|
Edges for the TagToPostConnection connection |
nodes - [Post!]!
|
The nodes of the connection, without the edges |
pageInfo - TagToPostConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [TagToPostConnectionEdge],
"nodes": [Post],
"pageInfo": TagToPostConnectionPageInfo
}
TagToPostConnectionEdge
TagToPostConnectionPageInfo
Description
Page Info on the "TagToPostConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "abc123",
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "abc123"
}
TagToPostConnectionWhereArgs
Description
Arguments for filtering the TagToPostConnection connection
Fields
| Input Field | Description |
|---|---|
author - Int
|
The user that's connected as the author of the object. Use the userId for the author object. |
authorIn - [ID]
|
Find objects connected to author(s) in the array of author's userIds |
authorName - String
|
Find objects connected to the author by the author's nicename |
authorNotIn - [ID]
|
Find objects NOT connected to author(s) in the array of author's userIds |
categoryId - Int
|
Category ID |
categoryIn - [ID]
|
Array of category IDs, used to display objects from one category OR another |
categoryName - String
|
Use Category Slug |
categoryNotIn - [ID]
|
Array of category IDs, used to display objects from one category OR another |
dateQuery - DateQueryInput
|
Filter the connection based on dates |
hasPassword - Boolean
|
True for objects with passwords; False for objects without passwords; null for all objects with or without passwords |
id - Int
|
Specific database ID of the object |
in - [ID]
|
Array of IDs for the objects to retrieve |
mimeType - MimeTypeEnum
|
Get objects with a specific mimeType property |
name - String
|
Slug / post_name of the object |
nameIn - [String]
|
Specify objects to retrieve. Use slugs |
notIn - [ID]
|
Specify IDs NOT to retrieve. If this is used in the same query as "in", it will be ignored |
orderby - [PostObjectsConnectionOrderbyInput]
|
What parameter to use to order the objects by. |
parent - ID
|
Use ID to return only children. Use 0 to return only top-level items |
parentIn - [ID]
|
Specify objects whose parent is in an array |
parentNotIn - [ID]
|
Specify posts whose parent is not in an array |
password - String
|
Show posts with a specific password. |
search - String
|
Show Posts based on a keyword search |
stati - [PostStatusEnum]
|
Retrieve posts where post status is in an array. |
status - PostStatusEnum
|
Show posts with a specific status. |
tag - String
|
Tag Slug |
tagId - String
|
Use Tag ID |
tagIn - [ID]
|
Array of tag IDs, used to display objects from one tag OR another |
tagNotIn - [ID]
|
Array of tag IDs, used to display objects from one tag OR another |
tagSlugAnd - [String]
|
Array of tag slugs, used to display objects from one tag AND another |
tagSlugIn - [String]
|
Array of tag slugs, used to include objects in ANY specified tags |
title - String
|
Title of the object |
Example
{
"author": 987,
"authorIn": ["4"],
"authorName": "abc123",
"authorNotIn": ["4"],
"categoryId": 123,
"categoryIn": ["4"],
"categoryName": "xyz789",
"categoryNotIn": [4],
"dateQuery": DateQueryInput,
"hasPassword": true,
"id": 987,
"in": ["4"],
"mimeType": "APPLICATION_MSWORD",
"name": "xyz789",
"nameIn": ["abc123"],
"notIn": [4],
"orderby": [PostObjectsConnectionOrderbyInput],
"parent": "4",
"parentIn": [4],
"parentNotIn": ["4"],
"password": "abc123",
"search": "abc123",
"stati": ["ACF_DISABLED"],
"status": "ACF_DISABLED",
"tag": "xyz789",
"tagId": "abc123",
"tagIn": [4],
"tagNotIn": [4],
"tagSlugAnd": ["xyz789"],
"tagSlugIn": ["xyz789"],
"title": "abc123"
}
TagToTaxonomyConnectionEdge
Description
Connection between the Tag type and the Taxonomy type
Example
{
"cursor": "xyz789",
"node": Taxonomy
}
Taxonomy
Description
A taxonomy object
Fields
| Field Name | Description |
|---|---|
connectedContentTypes - TaxonomyToContentTypeConnection
|
List of Content Types associated with the Taxonomy |
Arguments
|
|
connectedTerms - TaxonomyToTermNodeConnection
|
List of Term Nodes associated with the Taxonomy |
Arguments
|
|
description - String
|
Description of the taxonomy. This field is equivalent to WP_Taxonomy->description |
graphqlPluralName - String
|
The plural name of the post type within the GraphQL Schema. |
graphqlSingleName - String
|
The singular name of the post type within the GraphQL Schema. |
hierarchical - Boolean
|
Whether the taxonomy is hierarchical |
id - ID!
|
The globally unique identifier of the taxonomy object. |
isRestricted - Boolean
|
Whether the object is restricted from the current viewer |
label - String
|
Name of the taxonomy shown in the menu. Usually plural. |
name - String
|
The display name of the taxonomy. This field is equivalent to WP_Taxonomy->label |
public - Boolean
|
Whether the taxonomy is publicly queryable |
restBase - String
|
Name of content type to display in REST API "wp/v2" namespace. |
restControllerClass - String
|
The REST Controller class assigned to handling this content type. |
showCloud - Boolean
|
Whether to show the taxonomy as part of a tag cloud widget. This field is equivalent to WP_Taxonomy->show_tagcloud |
showInAdminColumn - Boolean
|
Whether to display a column for the taxonomy on its post type listing screens. |
showInGraphql - Boolean
|
Whether to add the post type to the GraphQL Schema. |
showInMenu - Boolean
|
Whether to show the taxonomy in the admin menu |
showInNavMenus - Boolean
|
Whether the taxonomy is available for selection in navigation menus. |
showInQuickEdit - Boolean
|
Whether to show the taxonomy in the quick/bulk edit panel. |
showInRest - Boolean
|
Whether to add the post type route in the REST API "wp/v2" namespace. |
showUi - Boolean
|
Whether to generate and allow a UI for managing terms in this taxonomy in the admin |
Example
{
"connectedContentTypes": TaxonomyToContentTypeConnection,
"connectedTerms": TaxonomyToTermNodeConnection,
"description": "abc123",
"graphqlPluralName": "xyz789",
"graphqlSingleName": "abc123",
"hierarchical": false,
"id": 4,
"isRestricted": false,
"label": "xyz789",
"name": "xyz789",
"public": true,
"restBase": "xyz789",
"restControllerClass": "xyz789",
"showCloud": true,
"showInAdminColumn": false,
"showInGraphql": true,
"showInMenu": false,
"showInNavMenus": false,
"showInQuickEdit": true,
"showInRest": true,
"showUi": true
}
TaxonomyConnection
Description
Connection to Taxonomy Nodes
Fields
| Field Name | Description |
|---|---|
edges - [TaxonomyConnectionEdge!]!
|
A list of edges (relational context) between RootQuery and connected Taxonomy Nodes |
nodes - [Taxonomy!]!
|
A list of connected Taxonomy Nodes |
pageInfo - TaxonomyConnectionPageInfo!
|
Information about pagination in a connection. |
Possible Types
| TaxonomyConnection Types |
|---|
Example
{
"edges": [TaxonomyConnectionEdge],
"nodes": [Taxonomy],
"pageInfo": TaxonomyConnectionPageInfo
}
TaxonomyConnectionEdge
Description
Edge between a Node and a connected Taxonomy
Fields
| Field Name | Description |
|---|---|
cursor - String
|
Opaque reference to the nodes position in the connection. Value can be used with pagination args. |
node - Taxonomy!
|
The connected Taxonomy Node |
Possible Types
| TaxonomyConnectionEdge Types |
|---|
Example
{
"cursor": "abc123",
"node": Taxonomy
}
TaxonomyConnectionPageInfo
Description
Page Info on the connected TaxonomyConnectionEdge
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Possible Types
| TaxonomyConnectionPageInfo Types |
|---|
Example
{
"endCursor": "xyz789",
"hasNextPage": false,
"hasPreviousPage": false,
"startCursor": "abc123"
}
TaxonomyEnum
Description
Allowed taxonomies
Values
| Enum Value | Description |
|---|---|
|
|
Taxonomy enum category |
|
|
Taxonomy enum post_format |
|
|
Taxonomy enum post_tag |
Example
"CATEGORY"
TaxonomyIdTypeEnum
Description
The Type of Identifier used to fetch a single Taxonomy node. To be used along with the "id" field. Default is "ID".
Values
| Enum Value | Description |
|---|---|
|
|
The globally unique ID |
|
|
The name of the taxonomy |
Example
"ID"
TaxonomyToContentTypeConnection
Description
Connection between the Taxonomy type and the ContentType type
Fields
| Field Name | Description |
|---|---|
edges - [TaxonomyToContentTypeConnectionEdge!]!
|
Edges for the TaxonomyToContentTypeConnection connection |
nodes - [ContentType!]!
|
The nodes of the connection, without the edges |
pageInfo - TaxonomyToContentTypeConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [TaxonomyToContentTypeConnectionEdge],
"nodes": [ContentType],
"pageInfo": TaxonomyToContentTypeConnectionPageInfo
}
TaxonomyToContentTypeConnectionEdge
Description
An edge in a connection
Fields
| Field Name | Description |
|---|---|
cursor - String
|
A cursor for use in pagination |
node - ContentType!
|
The item at the end of the edge |
Example
{
"cursor": "xyz789",
"node": ContentType
}
TaxonomyToContentTypeConnectionPageInfo
Description
Page Info on the "TaxonomyToContentTypeConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "xyz789",
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "abc123"
}
TaxonomyToTermNodeConnection
Description
Connection between the Taxonomy type and the TermNode type
Fields
| Field Name | Description |
|---|---|
edges - [TaxonomyToTermNodeConnectionEdge!]!
|
Edges for the TaxonomyToTermNodeConnection connection |
nodes - [TermNode!]!
|
The nodes of the connection, without the edges |
pageInfo - TaxonomyToTermNodeConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [TaxonomyToTermNodeConnectionEdge],
"nodes": [TermNode],
"pageInfo": TaxonomyToTermNodeConnectionPageInfo
}
TaxonomyToTermNodeConnectionEdge
TaxonomyToTermNodeConnectionPageInfo
Description
Page Info on the "TaxonomyToTermNodeConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "xyz789",
"hasNextPage": false,
"hasPreviousPage": false,
"startCursor": "xyz789"
}
TemplateEnum
Description
Get page object by template
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"frontPage"
TermNode
Description
Terms are nodes within a Taxonomy, used to group and relate other nodes.
Fields
| Field Name | Description |
|---|---|
count - Int
|
The number of objects connected to the object |
databaseId - Int!
|
Identifies the primary key from the database. |
description - String
|
The description of the object |
enqueuedScripts - TermNodeToEnqueuedScriptConnection
|
Connection between the TermNode type and the EnqueuedScript type |
Arguments
|
|
enqueuedStylesheets - TermNodeToEnqueuedStylesheetConnection
|
Connection between the TermNode type and the EnqueuedStylesheet type |
Arguments
|
|
id - ID!
|
The globally unique ID for the object |
isComment - Boolean!
|
Whether the node is a Comment |
isContentNode - Boolean!
|
Whether the node is a Content Node |
isFrontPage - Boolean!
|
Whether the node represents the front page. |
isPostsPage - Boolean!
|
Whether the node represents the blog page. |
isRestricted - Boolean
|
Whether the object is restricted from the current viewer |
isTermNode - Boolean!
|
Whether the node is a Term |
link - String
|
The link to the term |
name - String
|
The human friendly name of the object. |
slug - String
|
An alphanumeric identifier for the object unique to its type. |
taxonomyName - String
|
The name of the taxonomy that the object is associated with |
termGroupId - Int
|
The ID of the term group that this term object belongs to |
termTaxonomyId - Int
|
The taxonomy ID that the object is associated with |
uri - String
|
The unique resource identifier path |
Possible Types
| TermNode Types |
|---|
Example
{
"count": 123,
"databaseId": 987,
"description": "abc123",
"enqueuedScripts": TermNodeToEnqueuedScriptConnection,
"enqueuedStylesheets": TermNodeToEnqueuedStylesheetConnection,
"id": 4,
"isComment": false,
"isContentNode": false,
"isFrontPage": true,
"isPostsPage": true,
"isRestricted": true,
"isTermNode": true,
"link": "abc123",
"name": "abc123",
"slug": "xyz789",
"taxonomyName": "abc123",
"termGroupId": 123,
"termTaxonomyId": 123,
"uri": "xyz789"
}
TermNodeConnection
Description
Connection to TermNode Nodes
Fields
| Field Name | Description |
|---|---|
edges - [TermNodeConnectionEdge!]!
|
A list of edges (relational context) between RootQuery and connected TermNode Nodes |
nodes - [TermNode!]!
|
A list of connected TermNode Nodes |
pageInfo - TermNodeConnectionPageInfo!
|
Information about pagination in a connection. |
Possible Types
| TermNodeConnection Types |
|---|
Example
{
"edges": [TermNodeConnectionEdge],
"nodes": [TermNode],
"pageInfo": TermNodeConnectionPageInfo
}
TermNodeConnectionEdge
Description
Edge between a Node and a connected TermNode
Fields
| Field Name | Description |
|---|---|
cursor - String
|
Opaque reference to the nodes position in the connection. Value can be used with pagination args. |
node - TermNode!
|
The connected TermNode Node |
Possible Types
| TermNodeConnectionEdge Types |
|---|
Example
{
"cursor": "abc123",
"node": TermNode
}
TermNodeConnectionPageInfo
Description
Page Info on the connected TermNodeConnectionEdge
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Possible Types
| TermNodeConnectionPageInfo Types |
|---|
Example
{
"endCursor": "abc123",
"hasNextPage": false,
"hasPreviousPage": false,
"startCursor": "xyz789"
}
TermNodeIdTypeEnum
Description
The Type of Identifier used to fetch a single resource. Default is "ID". To be used along with the "id" field.
Values
| Enum Value | Description |
|---|---|
|
|
The Database ID for the node |
|
|
The hashed Global ID |
|
|
The name of the node |
|
|
Url friendly name of the node |
|
|
The URI for the node |
Example
"DATABASE_ID"
TermNodeToEnqueuedScriptConnection
Description
Connection between the TermNode type and the EnqueuedScript type
Fields
| Field Name | Description |
|---|---|
edges - [TermNodeToEnqueuedScriptConnectionEdge!]!
|
Edges for the TermNodeToEnqueuedScriptConnection connection |
nodes - [EnqueuedScript!]!
|
The nodes of the connection, without the edges |
pageInfo - TermNodeToEnqueuedScriptConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [TermNodeToEnqueuedScriptConnectionEdge],
"nodes": [EnqueuedScript],
"pageInfo": TermNodeToEnqueuedScriptConnectionPageInfo
}
TermNodeToEnqueuedScriptConnectionEdge
Description
An edge in a connection
Fields
| Field Name | Description |
|---|---|
cursor - String
|
A cursor for use in pagination |
node - EnqueuedScript!
|
The item at the end of the edge |
Example
{
"cursor": "abc123",
"node": EnqueuedScript
}
TermNodeToEnqueuedScriptConnectionPageInfo
Description
Page Info on the "TermNodeToEnqueuedScriptConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "abc123",
"hasNextPage": false,
"hasPreviousPage": false,
"startCursor": "abc123"
}
TermNodeToEnqueuedStylesheetConnection
Description
Connection between the TermNode type and the EnqueuedStylesheet type
Fields
| Field Name | Description |
|---|---|
edges - [TermNodeToEnqueuedStylesheetConnectionEdge!]!
|
Edges for the TermNodeToEnqueuedStylesheetConnection connection |
nodes - [EnqueuedStylesheet!]!
|
The nodes of the connection, without the edges |
pageInfo - TermNodeToEnqueuedStylesheetConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [TermNodeToEnqueuedStylesheetConnectionEdge],
"nodes": [EnqueuedStylesheet],
"pageInfo": TermNodeToEnqueuedStylesheetConnectionPageInfo
}
TermNodeToEnqueuedStylesheetConnectionEdge
Description
An edge in a connection
Fields
| Field Name | Description |
|---|---|
cursor - String
|
A cursor for use in pagination |
node - EnqueuedStylesheet!
|
The item at the end of the edge |
Example
{
"cursor": "abc123",
"node": EnqueuedStylesheet
}
TermNodeToEnqueuedStylesheetConnectionPageInfo
Description
Page Info on the "TermNodeToEnqueuedStylesheetConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "xyz789",
"hasNextPage": false,
"hasPreviousPage": true,
"startCursor": "abc123"
}
TermObjectsConnectionOrderbyEnum
Description
Options for ordering the connection by
Values
| Enum Value | Description |
|---|---|
|
|
Order the connection by item count. |
|
|
Order the connection by description. |
|
|
Order the connection by name. |
|
|
Order the connection by slug. |
|
|
Order the connection by term group. |
|
|
Order the connection by term id. |
|
|
Order the connection by term order. |
Example
"COUNT"
Theme
Description
A theme object
Fields
| Field Name | Description |
|---|---|
author - String
|
Name of the theme author(s), could also be a company name. This field is equivalent to WP_Theme->get( "Author" ). |
authorUri - String
|
URI for the author/company website. This field is equivalent to WP_Theme->get( "AuthorURI" ). |
description - String
|
The description of the theme. This field is equivalent to WP_Theme->get( "Description" ). |
id - ID!
|
The globally unique identifier of the theme object. |
isRestricted - Boolean
|
Whether the object is restricted from the current viewer |
name - String
|
Display name of the theme. This field is equivalent to WP_Theme->get( "Name" ). |
screenshot - String
|
The URL of the screenshot for the theme. The screenshot is intended to give an overview of what the theme looks like. This field is equivalent to WP_Theme->get_screenshot(). |
slug - String
|
The theme slug is used to internally match themes. Theme slugs can have subdirectories like: my-theme/sub-theme. This field is equivalent to WP_Theme->get_stylesheet(). |
tags - [String]
|
URI for the author/company website. This field is equivalent to WP_Theme->get( "Tags" ). |
themeUri - String
|
A URI if the theme has a website associated with it. The Theme URI is handy for directing users to a theme site for support etc. This field is equivalent to WP_Theme->get( "ThemeURI" ). |
version - String
|
The current version of the theme. This field is equivalent to WP_Theme->get( "Version" ). |
Example
{
"author": "abc123",
"authorUri": "abc123",
"description": "xyz789",
"id": 4,
"isRestricted": false,
"name": "xyz789",
"screenshot": "abc123",
"slug": "xyz789",
"tags": ["xyz789"],
"themeUri": "xyz789",
"version": "abc123"
}
ThemeConnection
Description
Connection to Theme Nodes
Fields
| Field Name | Description |
|---|---|
edges - [ThemeConnectionEdge!]!
|
A list of edges (relational context) between RootQuery and connected Theme Nodes |
nodes - [Theme!]!
|
A list of connected Theme Nodes |
pageInfo - ThemeConnectionPageInfo!
|
Information about pagination in a connection. |
Possible Types
| ThemeConnection Types |
|---|
Example
{
"edges": [ThemeConnectionEdge],
"nodes": [Theme],
"pageInfo": ThemeConnectionPageInfo
}
ThemeConnectionEdge
Description
Edge between a Node and a connected Theme
Fields
| Field Name | Description |
|---|---|
cursor - String
|
Opaque reference to the nodes position in the connection. Value can be used with pagination args. |
node - Theme!
|
The connected Theme Node |
Possible Types
| ThemeConnectionEdge Types |
|---|
Example
{
"cursor": "xyz789",
"node": Theme
}
ThemeConnectionPageInfo
Description
Page Info on the connected ThemeConnectionEdge
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Possible Types
| ThemeConnectionPageInfo Types |
|---|
Example
{
"endCursor": "xyz789",
"hasNextPage": true,
"hasPreviousPage": false,
"startCursor": "abc123"
}
Translation
Description
The translation type
Fields
| Field Name | Description |
|---|---|
contentType - ContentNodeToContentTypeConnectionEdge
|
Connection between the ContentNode type and the ContentType type |
contentTypeName - String!
|
The name of the Content Type the node belongs to |
databaseId - Int!
|
The unique identifier stored in the database |
date - String
|
Post publishing date. |
dateGmt - String
|
The publishing date set in GMT. |
desiredSlug - String
|
The desired slug of the post |
editingLockedBy - ContentNodeToEditLockConnectionEdge
|
If a user has edited the node within the past 15 seconds, this will return the user that last edited. Null if the edit lock doesn't exist or is greater than 15 seconds |
enclosure - String
|
The RSS enclosure for the object |
enqueuedScripts - ContentNodeToEnqueuedScriptConnection
|
Connection between the ContentNode type and the EnqueuedScript type |
Arguments
|
|
enqueuedStylesheets - ContentNodeToEnqueuedStylesheetConnection
|
Connection between the ContentNode type and the EnqueuedStylesheet type |
Arguments
|
|
guid - String
|
The global unique identifier for this post. This currently matches the value stored in WP_Post->guid and the guid column in the "post_objects" database table. |
id - ID!
|
The globally unique identifier of the translation-cpt object. |
isComment - Boolean!
|
Whether the node is a Comment |
isContentNode - Boolean!
|
Whether the node is a Content Node |
isFrontPage - Boolean!
|
Whether the node represents the front page. |
isPostsPage - Boolean!
|
Whether the node represents the blog page. |
isPreview - Boolean
|
Whether the object is a node in the preview state |
isRestricted - Boolean
|
Whether the object is restricted from the current viewer |
isRevision - Boolean
|
True if the node is a revision of another node |
isTermNode - Boolean!
|
Whether the node is a Term |
lastEditedBy - ContentNodeToEditLastConnectionEdge
|
The user that most recently edited the node |
link - String
|
The permalink of the post |
modified - String
|
The local modified time for a post. If a post was recently updated the modified field will change to match the corresponding time. |
modifiedGmt - String
|
The GMT modified time for a post. If a post was recently updated the modified field will change to match the corresponding time in GMT. |
preview - TranslationToPreviewConnectionEdge
|
Connection between the Translation type and the translation type |
previewRevisionDatabaseId - Int
|
The database id of the preview node |
previewRevisionId - ID
|
Whether the object is a node in the preview state |
revisionOf - NodeWithRevisionsToContentNodeConnectionEdge
|
If the current node is a revision, this field exposes the node this is a revision of. Returns null if the node is not a revision of another node. |
revisions - TranslationToRevisionConnection
|
Connection between the Translation type and the translation type |
Arguments
|
|
seo - SEO
|
The SEO Framework data of the translation |
slug - String
|
The uri slug for the post. This is equivalent to the WP_Post->post_name field and the post_name column in the database for the "post_objects" table. |
status - String
|
The current status of the object |
template - ContentTemplate
|
The template assigned to the node |
title - String
|
The title of the post. This is currently just the raw title. An amendment to support rendered title needs to be made. |
Arguments
|
|
translationId - Int!
|
The id field matches the WP_Post->ID field. Deprecated in favor of the databaseId field |
translations - [TranslationResponse]
|
Translations |
uri - String
|
The unique resource identifier path |
Example
{
"contentType": ContentNodeToContentTypeConnectionEdge,
"contentTypeName": "xyz789",
"databaseId": 123,
"date": "xyz789",
"dateGmt": "xyz789",
"desiredSlug": "xyz789",
"editingLockedBy": ContentNodeToEditLockConnectionEdge,
"enclosure": "abc123",
"enqueuedScripts": ContentNodeToEnqueuedScriptConnection,
"enqueuedStylesheets": ContentNodeToEnqueuedStylesheetConnection,
"guid": "abc123",
"id": 4,
"isComment": true,
"isContentNode": true,
"isFrontPage": false,
"isPostsPage": true,
"isPreview": true,
"isRestricted": true,
"isRevision": false,
"isTermNode": true,
"lastEditedBy": ContentNodeToEditLastConnectionEdge,
"link": "xyz789",
"modified": "xyz789",
"modifiedGmt": "xyz789",
"preview": TranslationToPreviewConnectionEdge,
"previewRevisionDatabaseId": 123,
"previewRevisionId": "4",
"revisionOf": NodeWithRevisionsToContentNodeConnectionEdge,
"revisions": TranslationToRevisionConnection,
"seo": SEO,
"slug": "xyz789",
"status": "xyz789",
"template": ContentTemplate,
"title": "abc123",
"translationId": 987,
"translations": [TranslationResponse],
"uri": "xyz789"
}
TranslationConnection
Description
Connection to translation Nodes
Fields
| Field Name | Description |
|---|---|
edges - [TranslationConnectionEdge!]!
|
A list of edges (relational context) between RootQuery and connected translation Nodes |
nodes - [Translation!]!
|
A list of connected translation Nodes |
pageInfo - TranslationConnectionPageInfo!
|
Information about pagination in a connection. |
Possible Types
| TranslationConnection Types |
|---|
Example
{
"edges": [TranslationConnectionEdge],
"nodes": [Translation],
"pageInfo": TranslationConnectionPageInfo
}
TranslationConnectionEdge
Description
Edge between a Node and a connected translation
Fields
| Field Name | Description |
|---|---|
cursor - String
|
Opaque reference to the nodes position in the connection. Value can be used with pagination args. |
node - Translation!
|
The connected translation Node |
Possible Types
| TranslationConnectionEdge Types |
|---|
Example
{
"cursor": "xyz789",
"node": Translation
}
TranslationConnectionPageInfo
Description
Page Info on the connected TranslationConnectionEdge
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Possible Types
| TranslationConnectionPageInfo Types |
|---|
Example
{
"endCursor": "abc123",
"hasNextPage": false,
"hasPreviousPage": true,
"startCursor": "xyz789"
}
TranslationIdType
Description
The Type of Identifier used to fetch a single resource. Default is ID.
Values
| Enum Value | Description |
|---|---|
|
|
Identify a resource by the Database ID. |
|
|
Identify a resource by the (hashed) Global ID. |
|
|
Identify a resource by the slug. Available to non-hierarchcial Types where the slug is a unique identifier. |
|
|
Identify a resource by the URI. |
Example
"DATABASE_ID"
TranslationItems
TranslationResponse
Description
Translation response contains translation key and translations
Fields
| Field Name | Description |
|---|---|
key - String
|
Translation key for frontend |
translations - TranslationItems
|
Translations for frontend |
Example
{
"key": "abc123",
"translations": TranslationItems
}
TranslationToPreviewConnectionEdge
Description
Connection between the Translation type and the translation type
Fields
| Field Name | Description |
|---|---|
cursor - String
|
Opaque reference to the nodes position in the connection. Value can be used with pagination args. |
node - Translation!
|
The node of the connection, without the edges |
Example
{
"cursor": "xyz789",
"node": Translation
}
TranslationToRevisionConnection
Description
Connection between the Translation type and the translation type
Fields
| Field Name | Description |
|---|---|
edges - [TranslationToRevisionConnectionEdge!]!
|
Edges for the TranslationToRevisionConnection connection |
nodes - [Translation!]!
|
The nodes of the connection, without the edges |
pageInfo - TranslationToRevisionConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [TranslationToRevisionConnectionEdge],
"nodes": [Translation],
"pageInfo": TranslationToRevisionConnectionPageInfo
}
TranslationToRevisionConnectionEdge
Description
An edge in a connection
Fields
| Field Name | Description |
|---|---|
cursor - String
|
A cursor for use in pagination |
node - Translation!
|
The item at the end of the edge |
Example
{
"cursor": "abc123",
"node": Translation
}
TranslationToRevisionConnectionPageInfo
Description
Page Info on the "TranslationToRevisionConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "abc123",
"hasNextPage": false,
"hasPreviousPage": false,
"startCursor": "abc123"
}
TranslationToRevisionConnectionWhereArgs
Description
Arguments for filtering the TranslationToRevisionConnection connection
Fields
| Input Field | Description |
|---|---|
dateQuery - DateQueryInput
|
Filter the connection based on dates |
hasPassword - Boolean
|
True for objects with passwords; False for objects without passwords; null for all objects with or without passwords |
id - Int
|
Specific database ID of the object |
in - [ID]
|
Array of IDs for the objects to retrieve |
mimeType - MimeTypeEnum
|
Get objects with a specific mimeType property |
name - String
|
Slug / post_name of the object |
nameIn - [String]
|
Specify objects to retrieve. Use slugs |
notIn - [ID]
|
Specify IDs NOT to retrieve. If this is used in the same query as "in", it will be ignored |
orderby - [PostObjectsConnectionOrderbyInput]
|
What parameter to use to order the objects by. |
parent - ID
|
Use ID to return only children. Use 0 to return only top-level items |
parentIn - [ID]
|
Specify objects whose parent is in an array |
parentNotIn - [ID]
|
Specify posts whose parent is not in an array |
password - String
|
Show posts with a specific password. |
search - String
|
Show Posts based on a keyword search |
stati - [PostStatusEnum]
|
Retrieve posts where post status is in an array. |
status - PostStatusEnum
|
Show posts with a specific status. |
title - String
|
Title of the object |
Example
{
"dateQuery": DateQueryInput,
"hasPassword": true,
"id": 123,
"in": [4],
"mimeType": "APPLICATION_MSWORD",
"name": "xyz789",
"nameIn": ["abc123"],
"notIn": [4],
"orderby": [PostObjectsConnectionOrderbyInput],
"parent": 4,
"parentIn": ["4"],
"parentNotIn": [4],
"password": "xyz789",
"search": "xyz789",
"stati": ["ACF_DISABLED"],
"status": "ACF_DISABLED",
"title": "xyz789"
}
UniformResourceIdentifiable
Description
Any node that has a URI
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The globally unique ID for the object |
isComment - Boolean!
|
Whether the node is a Comment |
isContentNode - Boolean!
|
Whether the node is a Content Node |
isFrontPage - Boolean!
|
Whether the node represents the front page. |
isPostsPage - Boolean!
|
Whether the node represents the blog page. |
isTermNode - Boolean!
|
Whether the node is a Term |
uri - String
|
The unique resource identifier path |
Possible Types
| UniformResourceIdentifiable Types |
|---|
Example
{
"id": "4",
"isComment": true,
"isContentNode": false,
"isFrontPage": true,
"isPostsPage": false,
"isTermNode": true,
"uri": "xyz789"
}
UpdateCategoryInput
Description
Input for the updateCategory mutation.
Fields
| Input Field | Description |
|---|---|
aliasOf - String
|
The slug that the category will be an alias of |
clientMutationId - String
|
This is an ID that can be passed to a mutation by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
description - String
|
The description of the category object |
id - ID!
|
The ID of the category object to update |
language - LanguageCodeEnum
|
|
name - String
|
The name of the category object to mutate |
parentId - ID
|
The ID of the category that should be set as the parent |
slug - String
|
If this argument exists then the slug will be checked to see if it is not an existing valid term. If that check succeeds (it is not a valid term), then it is added and the term id is given. If it fails, then a check is made to whether the taxonomy is hierarchical and the parent argument is not empty. If the second check succeeds, the term will be inserted and the term id will be given. If the slug argument is empty, then it will be calculated from the term name. |
Example
{
"aliasOf": "xyz789",
"clientMutationId": "abc123",
"description": "abc123",
"id": "4",
"language": "EN",
"name": "xyz789",
"parentId": "4",
"slug": "abc123"
}
UpdateCategoryPayload
Description
The payload for the updateCategory mutation.
Fields
| Field Name | Description |
|---|---|
category - Category
|
The created category |
clientMutationId - String
|
If a 'clientMutationId' input is provided to the mutation, it will be returned as output on the mutation. This ID can be used by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
Example
{
"category": Category,
"clientMutationId": "abc123"
}
UpdateCollectionInput
Description
Input for the updateCollection mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
This is an ID that can be passed to a mutation by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
date - String
|
The date of the object. Preferable to enter as year/month/day (e.g. 01/31/2017) as it will rearrange date as fit if it is not specified. Incomplete dates may have unintended results for example, "2017" as the input will use current date with timestamp 20:17 |
id - ID!
|
The ID of the collection object |
ignoreEditLock - Boolean
|
Override the edit lock when another user is editing the post |
language - LanguageCodeEnum
|
|
menuOrder - Int
|
A field used for ordering posts. This is typically used with nav menu items or for special ordering of hierarchical content types. |
password - String
|
The password used to protect the content of the object |
slug - String
|
The slug of the object |
status - PostStatusEnum
|
The status of the object |
title - String
|
The title of the object |
Example
{
"clientMutationId": "xyz789",
"date": "xyz789",
"id": "4",
"ignoreEditLock": true,
"language": "EN",
"menuOrder": 987,
"password": "abc123",
"slug": "abc123",
"status": "ACF_DISABLED",
"title": "xyz789"
}
UpdateCollectionPayload
Description
The payload for the updateCollection mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
If a 'clientMutationId' input is provided to the mutation, it will be returned as output on the mutation. This ID can be used by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
collection - Collection
|
The Post object mutation type. |
Example
{
"clientMutationId": "abc123",
"collection": Collection
}
UpdateCommentInput
Description
Input for the updateComment mutation.
Fields
| Input Field | Description |
|---|---|
approved - String
|
The approval status of the comment. |
author - String
|
The name of the comment's author. |
authorEmail - String
|
The email of the comment's author. |
authorUrl - String
|
The url of the comment's author. |
clientMutationId - String
|
This is an ID that can be passed to a mutation by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
commentOn - Int
|
The database ID of the post object the comment belongs to. |
content - String
|
Content of the comment. |
date - String
|
The date of the object. Preferable to enter as year/month/day ( e.g. 01/31/2017 ) as it will rearrange date as fit if it is not specified. Incomplete dates may have unintended results for example, "2017" as the input will use current date with timestamp 20:17 |
id - ID!
|
The ID of the comment being updated. |
parent - ID
|
Parent comment ID of current comment. |
status - CommentStatusEnum
|
The approval status of the comment |
type - String
|
Type of comment. |
Example
{
"approved": "abc123",
"author": "xyz789",
"authorEmail": "xyz789",
"authorUrl": "xyz789",
"clientMutationId": "xyz789",
"commentOn": 987,
"content": "xyz789",
"date": "xyz789",
"id": "4",
"parent": 4,
"status": "APPROVE",
"type": "abc123"
}
UpdateCommentPayload
Description
The payload for the updateComment mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
If a 'clientMutationId' input is provided to the mutation, it will be returned as output on the mutation. This ID can be used by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
comment - Comment
|
The comment that was created |
success - Boolean
|
Whether the mutation succeeded. If the comment is not approved, the server will not return the comment to a non authenticated user, but a success message can be returned if the create succeeded, and the client can optimistically add the comment to the client cache |
Example
{
"clientMutationId": "xyz789",
"comment": Comment,
"success": false
}
UpdateContactInput
Description
Input for the updateContact mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
This is an ID that can be passed to a mutation by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
date - String
|
The date of the object. Preferable to enter as year/month/day (e.g. 01/31/2017) as it will rearrange date as fit if it is not specified. Incomplete dates may have unintended results for example, "2017" as the input will use current date with timestamp 20:17 |
id - ID!
|
The ID of the contact object |
ignoreEditLock - Boolean
|
Override the edit lock when another user is editing the post |
language - LanguageCodeEnum
|
|
menuOrder - Int
|
A field used for ordering posts. This is typically used with nav menu items or for special ordering of hierarchical content types. |
password - String
|
The password used to protect the content of the object |
slug - String
|
The slug of the object |
status - PostStatusEnum
|
The status of the object |
title - String
|
The title of the object |
Example
{
"clientMutationId": "abc123",
"date": "abc123",
"id": "4",
"ignoreEditLock": true,
"language": "EN",
"menuOrder": 987,
"password": "abc123",
"slug": "abc123",
"status": "ACF_DISABLED",
"title": "abc123"
}
UpdateContactPayload
Description
The payload for the updateContact mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
If a 'clientMutationId' input is provided to the mutation, it will be returned as output on the mutation. This ID can be used by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
contact - Contact
|
The Post object mutation type. |
Example
{
"clientMutationId": "abc123",
"contact": Contact
}
UpdateLandingPageInput
Description
Input for the updateLandingPage mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
This is an ID that can be passed to a mutation by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
date - String
|
The date of the object. Preferable to enter as year/month/day (e.g. 01/31/2017) as it will rearrange date as fit if it is not specified. Incomplete dates may have unintended results for example, "2017" as the input will use current date with timestamp 20:17 |
id - ID!
|
The ID of the landingPage object |
ignoreEditLock - Boolean
|
Override the edit lock when another user is editing the post |
language - LanguageCodeEnum
|
|
menuOrder - Int
|
A field used for ordering posts. This is typically used with nav menu items or for special ordering of hierarchical content types. |
password - String
|
The password used to protect the content of the object |
slug - String
|
The slug of the object |
status - PostStatusEnum
|
The status of the object |
title - String
|
The title of the object |
Example
{
"clientMutationId": "abc123",
"date": "xyz789",
"id": 4,
"ignoreEditLock": true,
"language": "EN",
"menuOrder": 123,
"password": "xyz789",
"slug": "xyz789",
"status": "ACF_DISABLED",
"title": "abc123"
}
UpdateLandingPagePayload
Description
The payload for the updateLandingPage mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
If a 'clientMutationId' input is provided to the mutation, it will be returned as output on the mutation. This ID can be used by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
landingPage - LandingPage
|
The Post object mutation type. |
Example
{
"clientMutationId": "xyz789",
"landingPage": LandingPage
}
UpdateMediaItemInput
Description
Input for the updateMediaItem mutation.
Fields
| Input Field | Description |
|---|---|
altText - String
|
Alternative text to display when mediaItem is not displayed |
authorId - ID
|
The userId to assign as the author of the mediaItem |
caption - String
|
The caption for the mediaItem |
clientMutationId - String
|
This is an ID that can be passed to a mutation by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
commentStatus - String
|
The comment status for the mediaItem |
date - String
|
The date of the mediaItem |
dateGmt - String
|
The date (in GMT zone) of the mediaItem |
description - String
|
Description of the mediaItem |
filePath - String
|
The file name of the mediaItem |
fileType - MimeTypeEnum
|
The file type of the mediaItem |
id - ID!
|
The ID of the mediaItem object |
language - LanguageCodeEnum
|
|
parentId - ID
|
The ID of the parent object |
pingStatus - String
|
The ping status for the mediaItem |
slug - String
|
The slug of the mediaItem |
status - MediaItemStatusEnum
|
The status of the mediaItem |
title - String
|
The title of the mediaItem |
Example
{
"altText": "abc123",
"authorId": 4,
"caption": "xyz789",
"clientMutationId": "abc123",
"commentStatus": "xyz789",
"date": "abc123",
"dateGmt": "abc123",
"description": "abc123",
"filePath": "xyz789",
"fileType": "APPLICATION_MSWORD",
"id": "4",
"language": "EN",
"parentId": 4,
"pingStatus": "abc123",
"slug": "abc123",
"status": "AUTO_DRAFT",
"title": "abc123"
}
UpdateMediaItemPayload
Description
The payload for the updateMediaItem mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
If a 'clientMutationId' input is provided to the mutation, it will be returned as output on the mutation. This ID can be used by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
mediaItem - MediaItem
|
The MediaItem object mutation type. |
Example
{
"clientMutationId": "abc123",
"mediaItem": MediaItem
}
UpdatePageInput
Description
Input for the updatePage mutation.
Fields
| Input Field | Description |
|---|---|
authorId - ID
|
The userId to assign as the author of the object |
clientMutationId - String
|
This is an ID that can be passed to a mutation by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
content - String
|
The content of the object |
date - String
|
The date of the object. Preferable to enter as year/month/day (e.g. 01/31/2017) as it will rearrange date as fit if it is not specified. Incomplete dates may have unintended results for example, "2017" as the input will use current date with timestamp 20:17 |
id - ID!
|
The ID of the page object |
ignoreEditLock - Boolean
|
Override the edit lock when another user is editing the post |
language - LanguageCodeEnum
|
|
menuOrder - Int
|
A field used for ordering posts. This is typically used with nav menu items or for special ordering of hierarchical content types. |
parentId - ID
|
The ID of the parent object |
password - String
|
The password used to protect the content of the object |
slug - String
|
The slug of the object |
status - PostStatusEnum
|
The status of the object |
title - String
|
The title of the object |
Example
{
"authorId": 4,
"clientMutationId": "abc123",
"content": "abc123",
"date": "abc123",
"id": "4",
"ignoreEditLock": false,
"language": "EN",
"menuOrder": 123,
"parentId": "4",
"password": "abc123",
"slug": "abc123",
"status": "ACF_DISABLED",
"title": "abc123"
}
UpdatePagePayload
Description
The payload for the updatePage mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
If a 'clientMutationId' input is provided to the mutation, it will be returned as output on the mutation. This ID can be used by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
page - Page
|
The Post object mutation type. |
Example
{
"clientMutationId": "abc123",
"page": Page
}
UpdatePostFormatInput
Description
Input for the updatePostFormat mutation.
Fields
| Input Field | Description |
|---|---|
aliasOf - String
|
The slug that the post_format will be an alias of |
clientMutationId - String
|
This is an ID that can be passed to a mutation by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
description - String
|
The description of the post_format object |
id - ID!
|
The ID of the postFormat object to update |
name - String
|
The name of the post_format object to mutate |
slug - String
|
If this argument exists then the slug will be checked to see if it is not an existing valid term. If that check succeeds (it is not a valid term), then it is added and the term id is given. If it fails, then a check is made to whether the taxonomy is hierarchical and the parent argument is not empty. If the second check succeeds, the term will be inserted and the term id will be given. If the slug argument is empty, then it will be calculated from the term name. |
Example
{
"aliasOf": "xyz789",
"clientMutationId": "abc123",
"description": "abc123",
"id": "4",
"name": "xyz789",
"slug": "abc123"
}
UpdatePostFormatPayload
Description
The payload for the updatePostFormat mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
If a 'clientMutationId' input is provided to the mutation, it will be returned as output on the mutation. This ID can be used by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
postFormat - PostFormat
|
The created post_format |
Example
{
"clientMutationId": "abc123",
"postFormat": PostFormat
}
UpdatePostInput
Description
Input for the updatePost mutation.
Fields
| Input Field | Description |
|---|---|
authorId - ID
|
The userId to assign as the author of the object |
categories - PostCategoriesInput
|
Set connections between the post and categories |
clientMutationId - String
|
This is an ID that can be passed to a mutation by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
content - String
|
The content of the object |
date - String
|
The date of the object. Preferable to enter as year/month/day (e.g. 01/31/2017) as it will rearrange date as fit if it is not specified. Incomplete dates may have unintended results for example, "2017" as the input will use current date with timestamp 20:17 |
id - ID!
|
The ID of the post object |
ignoreEditLock - Boolean
|
Override the edit lock when another user is editing the post |
language - LanguageCodeEnum
|
|
menuOrder - Int
|
A field used for ordering posts. This is typically used with nav menu items or for special ordering of hierarchical content types. |
password - String
|
The password used to protect the content of the object |
postFormats - PostPostFormatsInput
|
Set connections between the post and postFormats |
slug - String
|
The slug of the object |
status - PostStatusEnum
|
The status of the object |
tags - PostTagsInput
|
Set connections between the post and tags |
title - String
|
The title of the object |
Example
{
"authorId": 4,
"categories": PostCategoriesInput,
"clientMutationId": "abc123",
"content": "xyz789",
"date": "abc123",
"id": "4",
"ignoreEditLock": true,
"language": "EN",
"menuOrder": 987,
"password": "xyz789",
"postFormats": PostPostFormatsInput,
"slug": "abc123",
"status": "ACF_DISABLED",
"tags": PostTagsInput,
"title": "xyz789"
}
UpdatePostPayload
Description
The payload for the updatePost mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
If a 'clientMutationId' input is provided to the mutation, it will be returned as output on the mutation. This ID can be used by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
post - Post
|
The Post object mutation type. |
Example
{
"clientMutationId": "abc123",
"post": Post
}
UpdateReleaseInput
Description
Input for the updateRelease mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
This is an ID that can be passed to a mutation by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
content - String
|
The content of the object |
date - String
|
The date of the object. Preferable to enter as year/month/day (e.g. 01/31/2017) as it will rearrange date as fit if it is not specified. Incomplete dates may have unintended results for example, "2017" as the input will use current date with timestamp 20:17 |
id - ID!
|
The ID of the release object |
ignoreEditLock - Boolean
|
Override the edit lock when another user is editing the post |
language - LanguageCodeEnum
|
|
menuOrder - Int
|
A field used for ordering posts. This is typically used with nav menu items or for special ordering of hierarchical content types. |
password - String
|
The password used to protect the content of the object |
slug - String
|
The slug of the object |
status - PostStatusEnum
|
The status of the object |
title - String
|
The title of the object |
Example
{
"clientMutationId": "abc123",
"content": "abc123",
"date": "abc123",
"id": "4",
"ignoreEditLock": true,
"language": "EN",
"menuOrder": 123,
"password": "xyz789",
"slug": "xyz789",
"status": "ACF_DISABLED",
"title": "xyz789"
}
UpdateReleasePayload
Description
The payload for the updateRelease mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
If a 'clientMutationId' input is provided to the mutation, it will be returned as output on the mutation. This ID can be used by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
release - Release
|
The Post object mutation type. |
Example
{
"clientMutationId": "abc123",
"release": Release
}
UpdateSettingsInput
Description
Input for the updateSettings mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
This is an ID that can be passed to a mutation by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
discussionSettingsDefaultCommentStatus - String
|
Salli uusien artikkelien kommentointi. |
discussionSettingsDefaultPingStatus - String
|
Salli linkki-ilmoitukset muista blogeista (pingback ja trackback) uusiin artikkeleihin. |
generalSettingsDateFormat - String
|
Muoto kaikille päivämäärän merkkijonoille. |
generalSettingsDescription - String
|
Sivuston kuvaus. |
generalSettingsLanguage - String
|
WordPressin kieli- ja maakoodi. |
generalSettingsStartOfWeek - Int
|
Viikonpäivän numero josta viikko alkaa. |
generalSettingsTimeFormat - String
|
Muoto kaikille kellonajan merkkijonoille. |
generalSettingsTimezone - String
|
Kaupunki samalla aikavyöhykkeellä kuin sinä. |
generalSettingsTitle - String
|
Sivuston otsikko. |
readingSettingsPageForPosts - Int
|
Tunniste sivusta, joka näyttää uusimmat artikkelit |
readingSettingsPageOnFront - Int
|
Tunniste sivusta, joka näytetään etusivulla |
readingSettingsPostsPerPage - Int
|
Näytä enintään |
readingSettingsShowOnFront - String
|
Mitä näytetään etusivulla |
writingSettingsDefaultCategory - Int
|
Oletuskategoria artikkeleille. |
writingSettingsDefaultPostFormat - String
|
Artikkelisivujen oletusmuoto. |
writingSettingsUseSmilies - Boolean
|
Muunna hymiöt kuviksi. |
Example
{
"clientMutationId": "xyz789",
"discussionSettingsDefaultCommentStatus": "abc123",
"discussionSettingsDefaultPingStatus": "xyz789",
"generalSettingsDateFormat": "abc123",
"generalSettingsDescription": "xyz789",
"generalSettingsLanguage": "abc123",
"generalSettingsStartOfWeek": 123,
"generalSettingsTimeFormat": "xyz789",
"generalSettingsTimezone": "abc123",
"generalSettingsTitle": "xyz789",
"readingSettingsPageForPosts": 987,
"readingSettingsPageOnFront": 123,
"readingSettingsPostsPerPage": 987,
"readingSettingsShowOnFront": "abc123",
"writingSettingsDefaultCategory": 123,
"writingSettingsDefaultPostFormat": "abc123",
"writingSettingsUseSmilies": false
}
UpdateSettingsPayload
Description
The payload for the updateSettings mutation.
Fields
| Field Name | Description |
|---|---|
allSettings - Settings
|
Update all settings. |
clientMutationId - String
|
If a 'clientMutationId' input is provided to the mutation, it will be returned as output on the mutation. This ID can be used by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
discussionSettings - DiscussionSettings
|
Update the DiscussionSettings setting. |
generalSettings - GeneralSettings
|
Update the GeneralSettings setting. |
readingSettings - ReadingSettings
|
Update the ReadingSettings setting. |
writingSettings - WritingSettings
|
Update the WritingSettings setting. |
Example
{
"allSettings": Settings,
"clientMutationId": "xyz789",
"discussionSettings": DiscussionSettings,
"generalSettings": GeneralSettings,
"readingSettings": ReadingSettings,
"writingSettings": WritingSettings
}
UpdateTagInput
Description
Input for the updateTag mutation.
Fields
| Input Field | Description |
|---|---|
aliasOf - String
|
The slug that the post_tag will be an alias of |
clientMutationId - String
|
This is an ID that can be passed to a mutation by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
description - String
|
The description of the post_tag object |
id - ID!
|
The ID of the tag object to update |
language - LanguageCodeEnum
|
|
name - String
|
The name of the post_tag object to mutate |
slug - String
|
If this argument exists then the slug will be checked to see if it is not an existing valid term. If that check succeeds (it is not a valid term), then it is added and the term id is given. If it fails, then a check is made to whether the taxonomy is hierarchical and the parent argument is not empty. If the second check succeeds, the term will be inserted and the term id will be given. If the slug argument is empty, then it will be calculated from the term name. |
Example
{
"aliasOf": "xyz789",
"clientMutationId": "abc123",
"description": "abc123",
"id": "4",
"language": "EN",
"name": "xyz789",
"slug": "abc123"
}
UpdateTagPayload
Description
The payload for the updateTag mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
If a 'clientMutationId' input is provided to the mutation, it will be returned as output on the mutation. This ID can be used by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
tag - Tag
|
The created post_tag |
Example
{
"clientMutationId": "xyz789",
"tag": Tag
}
UpdateTranslationInput
Description
Input for the updateTranslation mutation.
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
This is an ID that can be passed to a mutation by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
date - String
|
The date of the object. Preferable to enter as year/month/day (e.g. 01/31/2017) as it will rearrange date as fit if it is not specified. Incomplete dates may have unintended results for example, "2017" as the input will use current date with timestamp 20:17 |
id - ID!
|
The ID of the translation object |
ignoreEditLock - Boolean
|
Override the edit lock when another user is editing the post |
menuOrder - Int
|
A field used for ordering posts. This is typically used with nav menu items or for special ordering of hierarchical content types. |
password - String
|
The password used to protect the content of the object |
slug - String
|
The slug of the object |
status - PostStatusEnum
|
The status of the object |
title - String
|
The title of the object |
Example
{
"clientMutationId": "abc123",
"date": "xyz789",
"id": 4,
"ignoreEditLock": true,
"menuOrder": 987,
"password": "xyz789",
"slug": "abc123",
"status": "ACF_DISABLED",
"title": "abc123"
}
UpdateTranslationPayload
Description
The payload for the updateTranslation mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
If a 'clientMutationId' input is provided to the mutation, it will be returned as output on the mutation. This ID can be used by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
translation - Translation
|
The Post object mutation type. |
Example
{
"clientMutationId": "xyz789",
"translation": Translation
}
UpdateUserInput
Description
Input for the updateUser mutation.
Fields
| Input Field | Description |
|---|---|
aim - String
|
User's AOL IM account. |
clientMutationId - String
|
This is an ID that can be passed to a mutation by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
description - String
|
A string containing content about the user. |
displayName - String
|
A string that will be shown on the site. Defaults to user's username. It is likely that you will want to change this, for both appearance and security through obscurity (that is if you dont use and delete the default admin user). |
email - String
|
A string containing the user's email address. |
firstName - String
|
|
id - ID!
|
The ID of the user |
jabber - String
|
User's Jabber account. |
lastName - String
|
The user's last name. |
locale - String
|
User's locale. |
nicename - String
|
A string that contains a URL-friendly name for the user. The default is the user's username. |
nickname - String
|
The user's nickname, defaults to the user's username. |
password - String
|
A string that contains the plain text password for the user. |
registered - String
|
The date the user registered. Format is Y-m-d H:i:s. |
richEditing - String
|
A string for whether to enable the rich editor or not. False if not empty. |
roles - [String]
|
An array of roles to be assigned to the user. |
websiteUrl - String
|
A string containing the user's URL for the user's web site. |
yim - String
|
User's Yahoo IM account. |
Example
{
"aim": "xyz789",
"clientMutationId": "xyz789",
"description": "xyz789",
"displayName": "abc123",
"email": "xyz789",
"firstName": "abc123",
"id": "4",
"jabber": "xyz789",
"lastName": "abc123",
"locale": "xyz789",
"nicename": "xyz789",
"nickname": "xyz789",
"password": "xyz789",
"registered": "abc123",
"richEditing": "xyz789",
"roles": ["xyz789"],
"websiteUrl": "xyz789",
"yim": "abc123"
}
UpdateUserPayload
Description
The payload for the updateUser mutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
If a 'clientMutationId' input is provided to the mutation, it will be returned as output on the mutation. This ID can be used by the client to track the progress of mutations and catch possible duplicate mutation submissions. |
user - User
|
The User object mutation type. |
Example
{
"clientMutationId": "xyz789",
"user": User
}
User
Description
A User object
Fields
| Field Name | Description |
|---|---|
avatar - Avatar
|
Avatar object for user. The avatar object can be retrieved in different sizes by specifying the size argument. |
Arguments
|
|
capKey - String
|
User metadata option name. Usually it will be "wp_capabilities". |
capabilities - [String]
|
A list of capabilities (permissions) granted to the user |
comments - UserToCommentConnection
|
Connection between the User type and the Comment type |
Arguments
|
|
databaseId - Int!
|
Identifies the primary key from the database. |
description - String
|
Description of the user. |
email - String
|
Email address of the user. This is equivalent to the WP_User->user_email property. |
enqueuedScripts - UserToEnqueuedScriptConnection
|
Connection between the User type and the EnqueuedScript type |
Arguments
|
|
enqueuedStylesheets - UserToEnqueuedStylesheetConnection
|
Connection between the User type and the EnqueuedStylesheet type |
Arguments
|
|
extraCapabilities - [String]
|
A complete list of capabilities including capabilities inherited from a role. This is equivalent to the array keys of WP_User->allcaps. |
firstName - String
|
First name of the user. This is equivalent to the WP_User->user_first_name property. |
id - ID!
|
The globally unique identifier for the user object. |
isComment - Boolean!
|
Whether the node is a Comment |
isContentNode - Boolean!
|
Whether the node is a Content Node |
isFrontPage - Boolean!
|
Whether the node represents the front page. |
isPostsPage - Boolean!
|
Whether the node represents the blog page. |
isRestricted - Boolean
|
Whether the object is restricted from the current viewer |
isTermNode - Boolean!
|
Whether the node is a Term |
lastName - String
|
Last name of the user. This is equivalent to the WP_User->user_last_name property. |
locale - String
|
The preferred language locale set for the user. Value derived from get_user_locale(). |
mediaItems - UserToMediaItemConnection
|
Connection between the User type and the mediaItem type |
Arguments
|
|
name - String
|
Display name of the user. This is equivalent to the WP_User->display_name property. |
nicename - String
|
The nicename for the user. This field is equivalent to WP_User->user_nicename |
nickname - String
|
Nickname of the user. |
pages - UserToPageConnection
|
Connection between the User type and the page type |
Arguments
|
|
posts - UserToPostConnection
|
Connection between the User type and the post type |
Arguments
|
|
registeredDate - String
|
The date the user registered or was created. The field follows a full ISO8601 date string format. |
revisions - UserToRevisionsConnection
|
Connection between the User and Revisions authored by the user |
Arguments
|
|
roles - UserToUserRoleConnection
|
Connection between the User type and the UserRole type |
Arguments
|
|
shouldShowAdminToolbar - Boolean
|
Whether the Toolbar should be displayed when the user is viewing the site. |
slug - String
|
The slug for the user. This field is equivalent to WP_User->user_nicename |
uri - String
|
The unique resource identifier path |
url - String
|
A website url that is associated with the user. |
userId - Int
|
The Id of the user. Equivalent to WP_User->ID Deprecated in favor of the databaseId field |
username - String
|
Username for the user. This field is equivalent to WP_User->user_login. |
Example
{
"avatar": Avatar,
"capKey": "abc123",
"capabilities": ["abc123"],
"comments": UserToCommentConnection,
"databaseId": 987,
"description": "abc123",
"email": "abc123",
"enqueuedScripts": UserToEnqueuedScriptConnection,
"enqueuedStylesheets": UserToEnqueuedStylesheetConnection,
"extraCapabilities": ["abc123"],
"firstName": "xyz789",
"id": "4",
"isComment": false,
"isContentNode": true,
"isFrontPage": false,
"isPostsPage": true,
"isRestricted": true,
"isTermNode": true,
"lastName": "xyz789",
"locale": "xyz789",
"mediaItems": UserToMediaItemConnection,
"name": "xyz789",
"nicename": "abc123",
"nickname": "xyz789",
"pages": UserToPageConnection,
"posts": UserToPostConnection,
"registeredDate": "xyz789",
"revisions": UserToRevisionsConnection,
"roles": UserToUserRoleConnection,
"shouldShowAdminToolbar": false,
"slug": "xyz789",
"uri": "xyz789",
"url": "xyz789",
"userId": 987,
"username": "xyz789"
}
UserConnection
Description
Connection to User Nodes
Fields
| Field Name | Description |
|---|---|
edges - [UserConnectionEdge!]!
|
A list of edges (relational context) between RootQuery and connected User Nodes |
nodes - [User!]!
|
A list of connected User Nodes |
pageInfo - UserConnectionPageInfo!
|
Information about pagination in a connection. |
Possible Types
| UserConnection Types |
|---|
Example
{
"edges": [UserConnectionEdge],
"nodes": [User],
"pageInfo": UserConnectionPageInfo
}
UserConnectionEdge
Description
Edge between a Node and a connected User
Fields
| Field Name | Description |
|---|---|
cursor - String
|
Opaque reference to the nodes position in the connection. Value can be used with pagination args. |
node - User!
|
The connected User Node |
Possible Types
| UserConnectionEdge Types |
|---|
Example
{
"cursor": "abc123",
"node": User
}
UserConnectionPageInfo
Description
Page Info on the connected UserConnectionEdge
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Possible Types
| UserConnectionPageInfo Types |
|---|
Example
{
"endCursor": "xyz789",
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "xyz789"
}
UserNodeIdTypeEnum
Description
The Type of Identifier used to fetch a single User node. To be used along with the "id" field. Default is "ID".
Values
| Enum Value | Description |
|---|---|
|
|
The Database ID for the node |
|
|
The Email of the User |
|
|
The hashed Global ID |
|
|
The slug of the User |
|
|
The URI for the node |
|
|
The username the User uses to login with |
Example
"DATABASE_ID"
UserRole
Description
A user role object
Fields
| Field Name | Description |
|---|---|
capabilities - [String]
|
The capabilities that belong to this role |
displayName - String
|
The display name of the role |
id - ID!
|
The globally unique identifier for the user role object. |
isRestricted - Boolean
|
Whether the object is restricted from the current viewer |
name - String
|
The registered name of the role |
Example
{
"capabilities": ["xyz789"],
"displayName": "abc123",
"id": 4,
"isRestricted": true,
"name": "xyz789"
}
UserRoleConnection
Description
Connection to UserRole Nodes
Fields
| Field Name | Description |
|---|---|
edges - [UserRoleConnectionEdge!]!
|
A list of edges (relational context) between RootQuery and connected UserRole Nodes |
nodes - [UserRole!]!
|
A list of connected UserRole Nodes |
pageInfo - UserRoleConnectionPageInfo!
|
Information about pagination in a connection. |
Possible Types
| UserRoleConnection Types |
|---|
Example
{
"edges": [UserRoleConnectionEdge],
"nodes": [UserRole],
"pageInfo": UserRoleConnectionPageInfo
}
UserRoleConnectionEdge
Description
Edge between a Node and a connected UserRole
Fields
| Field Name | Description |
|---|---|
cursor - String
|
Opaque reference to the nodes position in the connection. Value can be used with pagination args. |
node - UserRole!
|
The connected UserRole Node |
Possible Types
| UserRoleConnectionEdge Types |
|---|
Example
{
"cursor": "xyz789",
"node": UserRole
}
UserRoleConnectionPageInfo
Description
Page Info on the connected UserRoleConnectionEdge
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Possible Types
| UserRoleConnectionPageInfo Types |
|---|
Example
{
"endCursor": "xyz789",
"hasNextPage": true,
"hasPreviousPage": false,
"startCursor": "abc123"
}
UserRoleEnum
Description
Names of available user roles
Values
| Enum Value | Description |
|---|---|
|
|
User role with specific capabilities |
|
|
User role with specific capabilities |
|
|
User role with specific capabilities |
|
|
User role with specific capabilities |
|
|
User role with specific capabilities |
|
|
User role with specific capabilities |
|
|
User role with specific capabilities |
|
|
User role with specific capabilities |
|
|
User role with specific capabilities |
Example
"ADMINISTRATOR"
UserToCommentConnection
Description
Connection between the User type and the Comment type
Fields
| Field Name | Description |
|---|---|
edges - [UserToCommentConnectionEdge!]!
|
Edges for the UserToCommentConnection connection |
nodes - [Comment!]!
|
The nodes of the connection, without the edges |
pageInfo - UserToCommentConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [UserToCommentConnectionEdge],
"nodes": [Comment],
"pageInfo": UserToCommentConnectionPageInfo
}
UserToCommentConnectionEdge
UserToCommentConnectionPageInfo
Description
Page Info on the "UserToCommentConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "abc123",
"hasNextPage": false,
"hasPreviousPage": false,
"startCursor": "abc123"
}
UserToCommentConnectionWhereArgs
Description
Arguments for filtering the UserToCommentConnection connection
Fields
| Input Field | Description |
|---|---|
authorEmail - String
|
Comment author email address. |
authorIn - [ID]
|
Array of author IDs to include comments for. |
authorNotIn - [ID]
|
Array of author IDs to exclude comments for. |
authorUrl - String
|
Comment author URL. |
commentIn - [ID]
|
Array of comment IDs to include. |
commentNotIn - [ID]
|
Array of IDs of users whose unapproved comments will be returned by the query regardless of status. |
commentType - String
|
Include comments of a given type. |
commentTypeIn - [String]
|
Include comments from a given array of comment types. |
commentTypeNotIn - String
|
Exclude comments from a given array of comment types. |
contentAuthor - [ID]
|
Content object author ID to limit results by. |
contentAuthorIn - [ID]
|
Array of author IDs to retrieve comments for. |
contentAuthorNotIn - [ID]
|
Array of author IDs not to retrieve comments for. |
contentId - ID
|
Limit results to those affiliated with a given content object ID. |
contentIdIn - [ID]
|
Array of content object IDs to include affiliated comments for. |
contentIdNotIn - [ID]
|
Array of content object IDs to exclude affiliated comments for. |
contentName - String
|
Content object name (i.e. slug ) to retrieve affiliated comments for. |
contentParent - Int
|
Content Object parent ID to retrieve affiliated comments for. |
contentStatus - [PostStatusEnum]
|
Array of content object statuses to retrieve affiliated comments for. Pass 'any' to match any value. |
contentType - [ContentTypeEnum]
|
Content object type or array of types to retrieve affiliated comments for. Pass 'any' to match any value. |
includeUnapproved - [ID]
|
Array of IDs or email addresses of users whose unapproved comments will be returned by the query regardless of $status. Default empty |
karma - Int
|
Karma score to retrieve matching comments for. |
order - OrderEnum
|
The cardinality of the order of the connection |
orderby - CommentsConnectionOrderbyEnum
|
Field to order the comments by. |
parent - Int
|
Parent ID of comment to retrieve children of. |
parentIn - [ID]
|
Array of parent IDs of comments to retrieve children for. |
parentNotIn - [ID]
|
Array of parent IDs of comments not to retrieve children for. |
search - String
|
Search term(s) to retrieve matching comments for. |
status - String
|
Comment status to limit results by. |
userId - ID
|
Include comments for a specific user ID. |
Example
{
"authorEmail": "xyz789",
"authorIn": ["4"],
"authorNotIn": ["4"],
"authorUrl": "xyz789",
"commentIn": ["4"],
"commentNotIn": ["4"],
"commentType": "abc123",
"commentTypeIn": ["xyz789"],
"commentTypeNotIn": "xyz789",
"contentAuthor": ["4"],
"contentAuthorIn": ["4"],
"contentAuthorNotIn": ["4"],
"contentId": "4",
"contentIdIn": ["4"],
"contentIdNotIn": [4],
"contentName": "abc123",
"contentParent": 987,
"contentStatus": ["ACF_DISABLED"],
"contentType": ["ATTACHMENT"],
"includeUnapproved": ["4"],
"karma": 123,
"order": "ASC",
"orderby": "COMMENT_AGENT",
"parent": 987,
"parentIn": [4],
"parentNotIn": ["4"],
"search": "xyz789",
"status": "abc123",
"userId": 4
}
UserToEnqueuedScriptConnection
Description
Connection between the User type and the EnqueuedScript type
Fields
| Field Name | Description |
|---|---|
edges - [UserToEnqueuedScriptConnectionEdge!]!
|
Edges for the UserToEnqueuedScriptConnection connection |
nodes - [EnqueuedScript!]!
|
The nodes of the connection, without the edges |
pageInfo - UserToEnqueuedScriptConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [UserToEnqueuedScriptConnectionEdge],
"nodes": [EnqueuedScript],
"pageInfo": UserToEnqueuedScriptConnectionPageInfo
}
UserToEnqueuedScriptConnectionEdge
Description
An edge in a connection
Fields
| Field Name | Description |
|---|---|
cursor - String
|
A cursor for use in pagination |
node - EnqueuedScript!
|
The item at the end of the edge |
Example
{
"cursor": "abc123",
"node": EnqueuedScript
}
UserToEnqueuedScriptConnectionPageInfo
Description
Page Info on the "UserToEnqueuedScriptConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "xyz789",
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "abc123"
}
UserToEnqueuedStylesheetConnection
Description
Connection between the User type and the EnqueuedStylesheet type
Fields
| Field Name | Description |
|---|---|
edges - [UserToEnqueuedStylesheetConnectionEdge!]!
|
Edges for the UserToEnqueuedStylesheetConnection connection |
nodes - [EnqueuedStylesheet!]!
|
The nodes of the connection, without the edges |
pageInfo - UserToEnqueuedStylesheetConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [UserToEnqueuedStylesheetConnectionEdge],
"nodes": [EnqueuedStylesheet],
"pageInfo": UserToEnqueuedStylesheetConnectionPageInfo
}
UserToEnqueuedStylesheetConnectionEdge
Description
An edge in a connection
Fields
| Field Name | Description |
|---|---|
cursor - String
|
A cursor for use in pagination |
node - EnqueuedStylesheet!
|
The item at the end of the edge |
Example
{
"cursor": "xyz789",
"node": EnqueuedStylesheet
}
UserToEnqueuedStylesheetConnectionPageInfo
Description
Page Info on the "UserToEnqueuedStylesheetConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "xyz789",
"hasNextPage": false,
"hasPreviousPage": false,
"startCursor": "xyz789"
}
UserToMediaItemConnection
Description
Connection between the User type and the mediaItem type
Fields
| Field Name | Description |
|---|---|
edges - [UserToMediaItemConnectionEdge!]!
|
Edges for the UserToMediaItemConnection connection |
nodes - [MediaItem!]!
|
The nodes of the connection, without the edges |
pageInfo - UserToMediaItemConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [UserToMediaItemConnectionEdge],
"nodes": [MediaItem],
"pageInfo": UserToMediaItemConnectionPageInfo
}
UserToMediaItemConnectionEdge
Description
An edge in a connection
Fields
| Field Name | Description |
|---|---|
cursor - String
|
A cursor for use in pagination |
node - MediaItem!
|
The item at the end of the edge |
Example
{
"cursor": "abc123",
"node": MediaItem
}
UserToMediaItemConnectionPageInfo
Description
Page Info on the "UserToMediaItemConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "abc123",
"hasNextPage": false,
"hasPreviousPage": true,
"startCursor": "abc123"
}
UserToMediaItemConnectionWhereArgs
Description
Arguments for filtering the UserToMediaItemConnection connection
Fields
| Input Field | Description |
|---|---|
author - Int
|
The user that's connected as the author of the object. Use the userId for the author object. |
authorIn - [ID]
|
Find objects connected to author(s) in the array of author's userIds |
authorName - String
|
Find objects connected to the author by the author's nicename |
authorNotIn - [ID]
|
Find objects NOT connected to author(s) in the array of author's userIds |
dateQuery - DateQueryInput
|
Filter the connection based on dates |
hasPassword - Boolean
|
True for objects with passwords; False for objects without passwords; null for all objects with or without passwords |
id - Int
|
Specific database ID of the object |
in - [ID]
|
Array of IDs for the objects to retrieve |
mimeType - MimeTypeEnum
|
Get objects with a specific mimeType property |
name - String
|
Slug / post_name of the object |
nameIn - [String]
|
Specify objects to retrieve. Use slugs |
notIn - [ID]
|
Specify IDs NOT to retrieve. If this is used in the same query as "in", it will be ignored |
orderby - [PostObjectsConnectionOrderbyInput]
|
What parameter to use to order the objects by. |
parent - ID
|
Use ID to return only children. Use 0 to return only top-level items |
parentIn - [ID]
|
Specify objects whose parent is in an array |
parentNotIn - [ID]
|
Specify posts whose parent is not in an array |
password - String
|
Show posts with a specific password. |
search - String
|
Show Posts based on a keyword search |
stati - [PostStatusEnum]
|
Retrieve posts where post status is in an array. |
status - PostStatusEnum
|
Show posts with a specific status. |
title - String
|
Title of the object |
Example
{
"author": 123,
"authorIn": ["4"],
"authorName": "abc123",
"authorNotIn": ["4"],
"dateQuery": DateQueryInput,
"hasPassword": false,
"id": 987,
"in": [4],
"mimeType": "APPLICATION_MSWORD",
"name": "xyz789",
"nameIn": ["xyz789"],
"notIn": [4],
"orderby": [PostObjectsConnectionOrderbyInput],
"parent": "4",
"parentIn": [4],
"parentNotIn": ["4"],
"password": "xyz789",
"search": "abc123",
"stati": ["ACF_DISABLED"],
"status": "ACF_DISABLED",
"title": "xyz789"
}
UserToPageConnection
Description
Connection between the User type and the page type
Fields
| Field Name | Description |
|---|---|
edges - [UserToPageConnectionEdge!]!
|
Edges for the UserToPageConnection connection |
nodes - [Page!]!
|
The nodes of the connection, without the edges |
pageInfo - UserToPageConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [UserToPageConnectionEdge],
"nodes": [Page],
"pageInfo": UserToPageConnectionPageInfo
}
UserToPageConnectionEdge
UserToPageConnectionPageInfo
Description
Page Info on the "UserToPageConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "abc123",
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "abc123"
}
UserToPageConnectionWhereArgs
Description
Arguments for filtering the UserToPageConnection connection
Fields
| Input Field | Description |
|---|---|
author - Int
|
The user that's connected as the author of the object. Use the userId for the author object. |
authorIn - [ID]
|
Find objects connected to author(s) in the array of author's userIds |
authorName - String
|
Find objects connected to the author by the author's nicename |
authorNotIn - [ID]
|
Find objects NOT connected to author(s) in the array of author's userIds |
dateQuery - DateQueryInput
|
Filter the connection based on dates |
hasPassword - Boolean
|
True for objects with passwords; False for objects without passwords; null for all objects with or without passwords |
id - Int
|
Specific database ID of the object |
in - [ID]
|
Array of IDs for the objects to retrieve |
mimeType - MimeTypeEnum
|
Get objects with a specific mimeType property |
name - String
|
Slug / post_name of the object |
nameIn - [String]
|
Specify objects to retrieve. Use slugs |
notIn - [ID]
|
Specify IDs NOT to retrieve. If this is used in the same query as "in", it will be ignored |
orderby - [PostObjectsConnectionOrderbyInput]
|
What parameter to use to order the objects by. |
parent - ID
|
Use ID to return only children. Use 0 to return only top-level items |
parentIn - [ID]
|
Specify objects whose parent is in an array |
parentNotIn - [ID]
|
Specify posts whose parent is not in an array |
password - String
|
Show posts with a specific password. |
search - String
|
Show Posts based on a keyword search |
stati - [PostStatusEnum]
|
Retrieve posts where post status is in an array. |
status - PostStatusEnum
|
Show posts with a specific status. |
title - String
|
Title of the object |
Example
{
"author": 987,
"authorIn": [4],
"authorName": "abc123",
"authorNotIn": ["4"],
"dateQuery": DateQueryInput,
"hasPassword": false,
"id": 987,
"in": [4],
"mimeType": "APPLICATION_MSWORD",
"name": "abc123",
"nameIn": ["xyz789"],
"notIn": ["4"],
"orderby": [PostObjectsConnectionOrderbyInput],
"parent": 4,
"parentIn": ["4"],
"parentNotIn": [4],
"password": "abc123",
"search": "abc123",
"stati": ["ACF_DISABLED"],
"status": "ACF_DISABLED",
"title": "abc123"
}
UserToPostConnection
Description
Connection between the User type and the post type
Fields
| Field Name | Description |
|---|---|
edges - [UserToPostConnectionEdge!]!
|
Edges for the UserToPostConnection connection |
nodes - [Post!]!
|
The nodes of the connection, without the edges |
pageInfo - UserToPostConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [UserToPostConnectionEdge],
"nodes": [Post],
"pageInfo": UserToPostConnectionPageInfo
}
UserToPostConnectionEdge
UserToPostConnectionPageInfo
Description
Page Info on the "UserToPostConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "xyz789",
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "abc123"
}
UserToPostConnectionWhereArgs
Description
Arguments for filtering the UserToPostConnection connection
Fields
| Input Field | Description |
|---|---|
author - Int
|
The user that's connected as the author of the object. Use the userId for the author object. |
authorIn - [ID]
|
Find objects connected to author(s) in the array of author's userIds |
authorName - String
|
Find objects connected to the author by the author's nicename |
authorNotIn - [ID]
|
Find objects NOT connected to author(s) in the array of author's userIds |
categoryId - Int
|
Category ID |
categoryIn - [ID]
|
Array of category IDs, used to display objects from one category OR another |
categoryName - String
|
Use Category Slug |
categoryNotIn - [ID]
|
Array of category IDs, used to display objects from one category OR another |
dateQuery - DateQueryInput
|
Filter the connection based on dates |
hasPassword - Boolean
|
True for objects with passwords; False for objects without passwords; null for all objects with or without passwords |
id - Int
|
Specific database ID of the object |
in - [ID]
|
Array of IDs for the objects to retrieve |
mimeType - MimeTypeEnum
|
Get objects with a specific mimeType property |
name - String
|
Slug / post_name of the object |
nameIn - [String]
|
Specify objects to retrieve. Use slugs |
notIn - [ID]
|
Specify IDs NOT to retrieve. If this is used in the same query as "in", it will be ignored |
orderby - [PostObjectsConnectionOrderbyInput]
|
What parameter to use to order the objects by. |
parent - ID
|
Use ID to return only children. Use 0 to return only top-level items |
parentIn - [ID]
|
Specify objects whose parent is in an array |
parentNotIn - [ID]
|
Specify posts whose parent is not in an array |
password - String
|
Show posts with a specific password. |
search - String
|
Show Posts based on a keyword search |
stati - [PostStatusEnum]
|
Retrieve posts where post status is in an array. |
status - PostStatusEnum
|
Show posts with a specific status. |
tag - String
|
Tag Slug |
tagId - String
|
Use Tag ID |
tagIn - [ID]
|
Array of tag IDs, used to display objects from one tag OR another |
tagNotIn - [ID]
|
Array of tag IDs, used to display objects from one tag OR another |
tagSlugAnd - [String]
|
Array of tag slugs, used to display objects from one tag AND another |
tagSlugIn - [String]
|
Array of tag slugs, used to include objects in ANY specified tags |
title - String
|
Title of the object |
Example
{
"author": 987,
"authorIn": ["4"],
"authorName": "xyz789",
"authorNotIn": ["4"],
"categoryId": 123,
"categoryIn": [4],
"categoryName": "xyz789",
"categoryNotIn": [4],
"dateQuery": DateQueryInput,
"hasPassword": false,
"id": 987,
"in": ["4"],
"mimeType": "APPLICATION_MSWORD",
"name": "abc123",
"nameIn": ["abc123"],
"notIn": ["4"],
"orderby": [PostObjectsConnectionOrderbyInput],
"parent": "4",
"parentIn": [4],
"parentNotIn": ["4"],
"password": "xyz789",
"search": "abc123",
"stati": ["ACF_DISABLED"],
"status": "ACF_DISABLED",
"tag": "xyz789",
"tagId": "abc123",
"tagIn": [4],
"tagNotIn": [4],
"tagSlugAnd": ["abc123"],
"tagSlugIn": ["xyz789"],
"title": "abc123"
}
UserToRevisionsConnection
Description
Connection between the User type and the ContentNode type
Fields
| Field Name | Description |
|---|---|
edges - [UserToRevisionsConnectionEdge!]!
|
Edges for the UserToRevisionsConnection connection |
nodes - [ContentNode!]!
|
The nodes of the connection, without the edges |
pageInfo - UserToRevisionsConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [UserToRevisionsConnectionEdge],
"nodes": [ContentNode],
"pageInfo": UserToRevisionsConnectionPageInfo
}
UserToRevisionsConnectionEdge
Description
An edge in a connection
Fields
| Field Name | Description |
|---|---|
cursor - String
|
A cursor for use in pagination |
node - ContentNode!
|
The item at the end of the edge |
Example
{
"cursor": "xyz789",
"node": ContentNode
}
UserToRevisionsConnectionPageInfo
Description
Page Info on the "UserToRevisionsConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "abc123",
"hasNextPage": false,
"hasPreviousPage": true,
"startCursor": "abc123"
}
UserToRevisionsConnectionWhereArgs
Description
Arguments for filtering the UserToRevisionsConnection connection
Fields
| Input Field | Description |
|---|---|
contentTypes - [ContentTypeEnum]
|
The Types of content to filter |
dateQuery - DateQueryInput
|
Filter the connection based on dates |
hasPassword - Boolean
|
True for objects with passwords; False for objects without passwords; null for all objects with or without passwords |
id - Int
|
Specific database ID of the object |
in - [ID]
|
Array of IDs for the objects to retrieve |
mimeType - MimeTypeEnum
|
Get objects with a specific mimeType property |
name - String
|
Slug / post_name of the object |
nameIn - [String]
|
Specify objects to retrieve. Use slugs |
notIn - [ID]
|
Specify IDs NOT to retrieve. If this is used in the same query as "in", it will be ignored |
orderby - [PostObjectsConnectionOrderbyInput]
|
What parameter to use to order the objects by. |
parent - ID
|
Use ID to return only children. Use 0 to return only top-level items |
parentIn - [ID]
|
Specify objects whose parent is in an array |
parentNotIn - [ID]
|
Specify posts whose parent is not in an array |
password - String
|
Show posts with a specific password. |
search - String
|
Show Posts based on a keyword search |
stati - [PostStatusEnum]
|
Retrieve posts where post status is in an array. |
status - PostStatusEnum
|
Show posts with a specific status. |
title - String
|
Title of the object |
Example
{
"contentTypes": ["ATTACHMENT"],
"dateQuery": DateQueryInput,
"hasPassword": true,
"id": 123,
"in": ["4"],
"mimeType": "APPLICATION_MSWORD",
"name": "xyz789",
"nameIn": ["abc123"],
"notIn": [4],
"orderby": [PostObjectsConnectionOrderbyInput],
"parent": 4,
"parentIn": [4],
"parentNotIn": ["4"],
"password": "abc123",
"search": "xyz789",
"stati": ["ACF_DISABLED"],
"status": "ACF_DISABLED",
"title": "xyz789"
}
UserToUserRoleConnection
Description
Connection between the User type and the UserRole type
Fields
| Field Name | Description |
|---|---|
edges - [UserToUserRoleConnectionEdge!]!
|
Edges for the UserToUserRoleConnection connection |
nodes - [UserRole!]!
|
The nodes of the connection, without the edges |
pageInfo - UserToUserRoleConnectionPageInfo!
|
Information about pagination in a connection. |
Example
{
"edges": [UserToUserRoleConnectionEdge],
"nodes": [UserRole],
"pageInfo": UserToUserRoleConnectionPageInfo
}
UserToUserRoleConnectionEdge
UserToUserRoleConnectionPageInfo
Description
Page Info on the "UserToUserRoleConnection"
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "abc123",
"hasNextPage": false,
"hasPreviousPage": true,
"startCursor": "xyz789"
}
UsersConnectionOrderbyEnum
Description
Field to order the connection by
Values
| Enum Value | Description |
|---|---|
|
|
Order by display name |
|
|
Order by email address |
|
|
Order by login |
|
|
Preserve the login order given in the LOGIN_IN array |
|
|
Order by nice name |
|
|
Preserve the nice name order given in the NICE_NAME_IN array |
|
|
Order by registration date |
|
|
Order by URL |
Example
"DISPLAY_NAME"
UsersConnectionOrderbyInput
Description
Options for ordering the connection
Fields
| Input Field | Description |
|---|---|
field - UsersConnectionOrderbyEnum!
|
The field name used to sort the results. |
order - OrderEnum
|
The cardinality of the order of the connection |
Example
{"field": "DISPLAY_NAME", "order": "ASC"}
UsersConnectionSearchColumnEnum
Description
Column used for searching for users.
Values
| Enum Value | Description |
|---|---|
|
|
The user's email address. |
|
|
The globally unique ID. |
|
|
The username the User uses to login with. |
|
|
A URL-friendly name for the user. The default is the user's username. |
|
|
The URL of the user's website. |
Example
"EMAIL"
WPPageInfo
Description
Information about pagination in a connection.
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Possible Types
| WPPageInfo Types |
|---|
|
|
|
|
Example
{
"endCursor": "xyz789",
"hasNextPage": false,
"hasPreviousPage": true,
"startCursor": "xyz789"
}
WritingSettings
Description
The writing setting type
Example
{
"defaultCategory": 123,
"defaultPostFormat": "xyz789",
"useSmilies": true
}